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

Several doc pages under Running TARDIS section are missing from TOC #1177

Closed
jaladh-singhal opened this issue Jun 1, 2020 · 0 comments
Closed
Assignees

Comments

@jaladh-singhal
Copy link
Member

There are several helpful doc pages in TARDIS documentation which do appear on keyword searching the docs but not in TOC which is expected way of accessing.

  1. In Interacting with TARDIS section of tardis docs, there is no TOC defined. Thus a docs user can't access the contents (notebooks and rst files) that are actually present in this section.

  2. Similarly in Running TARDIS section, the to_hdf.rst and using_formal_integral.rst are not listed in TOC despite they are present in source.

  3. Storing simulations to HDF page page (which is not yet listed in TOC as mentioned in point 2) have incorrect linking to the notebooks which are actually present in interaction directory with same name.

Some Pointers

  • There maybe several other pages which are not yet listed (or listed incorrectly) in TARDIS docs, it'll be better if we get them fixed.
  • Last time I locally build Sphinx docs, it threw lot of warnings about things that are present in source but not listed in any toc of that directory - those warnings can be great starting point to figure out where linking is wrong or missing.
isaacgsmith added a commit to isaacgsmith/tardis that referenced this issue Nov 25, 2020
@isaacgsmith isaacgsmith mentioned this issue Nov 27, 2020
7 tasks
wkerzendorf pushed a commit that referenced this issue Nov 30, 2020
* fixing issue #1177

* fixing notebook headers so they don't show up in toc

* fixing toctree for docs/running/index

* adding notebooks to toctree

* fixing notebook headings to not show up in toctree
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this issue Oct 1, 2021
* fixing issue tardis-sn#1177

* fixing notebook headers so they don't show up in toc

* fixing toctree for docs/running/index

* adding notebooks to toctree

* fixing notebook headings to not show up in toctree
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants