Skip to content

Commit

Permalink
docs: Remove 2nd toctree and add advanced.md page
Browse files Browse the repository at this point in the history
The second `.. toctree::` was not being rendered for some reason. Instead a new page `docs/advanced.md` has been created
and serves as an index to the documentation which resides under `advanced/` with sub-headings for each section as I can
envisage this growing as more functionality is added.
  • Loading branch information
ns-rse committed Oct 15, 2024
1 parent 2620669 commit b36aef2
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 9 deletions.
10 changes: 10 additions & 0 deletions docs/advanced.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Advanced Documentation

You can read more detailed information about the methods implemented in TopoStats in the pages below.

## DNA Tracing

- [Disordered Tracing](advanced/disordered_tracing.md)
- [Nodestats](advanced/nodestats.md)
- [Ordered Tracing](advanced/Ordered_tracing.md)
- [Splining](advanced/splining.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 1 addition & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,13 @@ listed below to find out more.
configuration
contributing
notebooks
advanced
workflow
data_dictionary
related_software
glossary
faq

.. toctree::
:maxdepth: 1
:caption: Advanced Documentation
advanced/disordered_tracing
advanced/nodestats
advanced/ordered_tracing
advanced/splining


.. toctree::
:maxdepth: 1
:caption: API
Expand Down

0 comments on commit b36aef2

Please sign in to comment.