Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
May 20, 2024

Conversation

jacklovell
Copy link
Member

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.

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.
Copy link
Member

@vsnever vsnever left a comment

Choose a reason for hiding this comment

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

Thanks, @jacklovell. Indeed, it was difficult to find errors in the docs due to the large number of warnings. This fixed the problem for me.

There are three legacy files in the docs, presumably originating from a pre-release version of Cherab, also not included in the documentation tree, namely: models/beam/beam_attenuation_calculation.rst, models/cxs/atomic_data_calculation.rst, plasmas/plasma_sources.rst. However, I think that these three files should be left as is, even if they generate warnings, because otherwise we will forget about them, and they contain useful information that can be transferred to some other files in the future.

@jacklovell
Copy link
Member Author

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.

@jacklovell jacklovell merged commit b0dae07 into development May 20, 2024
16 checks passed
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.

None yet

2 participants