Skip to content

Add supported-table directive that validates whether all different targets we support are documented#116

Merged
Miauwkeru merged 6 commits intomainfrom
up-to-date-supported-targets
Apr 14, 2026
Merged

Add supported-table directive that validates whether all different targets we support are documented#116
Miauwkeru merged 6 commits intomainfrom
up-to-date-supported-targets

Conversation

@Miauwkeru
Copy link
Copy Markdown
Collaborator

@Miauwkeru Miauwkeru commented Apr 9, 2026

This adds a .. dissect-supported-table directive which verifies whether our tables in supported-targets.rst are still up to date

The directive itself provides the following options:

  • source-path: where it needs to start looking for modules within the directory specified by the dissect_projects_path config value (required)
  • blacklist: a comma seperated list that tells the plugin to ignore those modules
  • glob-pattern: a pattern to search for inside source-path if not specified it uses *.py by default

closes #106

Comment thread docs/source/conf.py Outdated
@Miauwkeru Miauwkeru requested a review from Schamper April 9, 2026 12:53
@Miauwkeru Miauwkeru force-pushed the up-to-date-supported-targets branch from 8948bf8 to 26c529c Compare April 9, 2026 13:10
Comment thread docs/source/_ext/dissect_supported_table.py
Comment thread docs/source/_ext/dissect_supported_table.py Outdated
Comment thread docs/source/_ext/dissect_supported_table.py Outdated
Comment thread docs/source/_ext/dissect_supported_table.py
Comment thread docs/source/supported-targets.rst
@Miauwkeru Miauwkeru requested a review from Schamper April 13, 2026 14:04
Copy link
Copy Markdown
Member

@Schamper Schamper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See reply

@Miauwkeru Miauwkeru requested a review from Schamper April 13, 2026 14:24
@Miauwkeru Miauwkeru merged commit f12b09c into main Apr 14, 2026
1 check passed
@Miauwkeru Miauwkeru deleted the up-to-date-supported-targets branch April 14, 2026 06:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CI/Sphinx plugin to verify that "supported targets" is up to date

2 participants