-
Notifications
You must be signed in to change notification settings - Fork 2.1k
[Feature Request] doc: create top-level module checker #8972
Copy link
Copy link
Closed
Labels
Area: docArea: DocumentationArea: DocumentationType: enhancementThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentationThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentationType: new featureThe issue requests / The PR implemements a new feature for RIOTThe issue requests / The PR implemements a new feature for RIOT
Milestone
Description
Description
It appears to be every week or so that someone breaks the top-level module view of our nice rendered doc (see #8973 for the most current example). Main culprit most of the time is that they set @ingroup to a group that does not exist.
How about we provide a checker script that checks modules.html directly after the doc was build by the CI, if the list of modules is in line with a given list provided with that checker? If the author of a PR really intends to add a new top-level module (which should rarely happen anyway) they can just append there new module to that list.
Reactions are currently unavailable
Metadata
Metadata
Labels
Area: docArea: DocumentationArea: DocumentationType: enhancementThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentationThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentationType: new featureThe issue requests / The PR implemements a new feature for RIOTThe issue requests / The PR implemements a new feature for RIOT