search

cherab / core

The core source repository for the Cherab project.
https://www.cherab.info
Other
44 stars 24 forks source link

Fix Sphinx warnings about documents not being included in toctree #434

Closed jacklovell closed 3 months ago

jacklovell commented 3 months ago

The demos are in fact not included in any toctree, but they are not intended to be so mark them as orphans as recommended in the Sphinx documentation.

These warnings make it harder to spot other - genuine - warnings, so removing them is useful for ensuring documentation is produced correctly.

jacklovell commented 3 months ago

Yes, I deliberately left those files in there. The information in them should be checked for accuracy and transferred into public documentation, but that's out of the scope of this particular PR.