You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
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.
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.
The text was updated successfully, but these errors were encountered:
* 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
* 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
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.
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.
Similarly in Running TARDIS section, the
to_hdf.rst
andusing_formal_integral.rst
are not listed in TOC despite they are present in source.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
The text was updated successfully, but these errors were encountered: