Skip to content
New issue

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

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

Already on GitHub? # to your account

Clean up toctrees #155

Merged
merged 2 commits into from
Mar 7, 2017
Merged

Clean up toctrees #155

merged 2 commits into from
Mar 7, 2017

Conversation

ketch
Copy link
Member

@ketch ketch commented Mar 7, 2017

This is an attempt to make the hierarchy of the docs a little bit clearer and at the same time deal with all warnings currently being thrown by sphinx.

Embed TOC for AMRClaw, GeoClaw, etc. in pages dedicated to them
and reduce the length of the main TOC in contents.rst.

Add :orphan: tag to pages not listed in any toctree, so that
sphinx doesn't complain about them.

Various other improvements to the documentation.

I deleted flag.rst since it is included completely in refinement.rst.

ketch added 2 commits March 6, 2017 15:05
Embed TOC for AMRClaw, GeoClaw, etc. in pages dedicated to them
and reduce the length of the main TOC in contents.rst.

Add :orphan: tag to pages not listed in any toctree, so that
sphinx doesn't complain about them.

Various other improvements to the documentation.
@ketch
Copy link
Member Author

ketch commented Mar 7, 2017

After these changes, the only remaining warnings from Sphinx are #153 and #154.

@ketch
Copy link
Member Author

ketch commented Mar 7, 2017

Since nobody has objected, I'm going to go ahead and merge this because my next step is to start including Jupyter notebooks in the docs via nbsphinx, and both of these involve substantial changes and I'd like to avoid dealing with conflicts.

@ketch ketch merged commit fa195d3 into clawpack:master Mar 7, 2017
@ketch ketch deleted the clean_up_toctrees branch March 7, 2017 22:09
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant