lsst-sqre / documenteer

Sphinx extensions, configurations, and tooling for Rubin Observatory documentation projects
https://documenteer.lsst.io
MIT License
5 stars 3 forks source link

DM-15007: Add -s/--skip options to stack-docs app #41

Closed jonathansick closed 6 years ago

jonathansick commented 6 years ago

This PR tries to solve the problem of temporarily omitting either modules or packages from being included in pipelines documentation.

The best solution is the -s/--skip option for stack-docs that prevents the named package and/or module documentation directories from being linked into the main documentation repository.

This PR also adds skip options to the module-toctree and package-toctree directives. This solution isn't fully useful until those directives can also remove those documentation directories from the Sphinx build tree.