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
@jjscheel There is one issue that I noticed in using markdown with Sphinx.
Right now there is no subchapter in the index on the left bar. But as we proceed, we will need that in our docs. Each subsection requires its own toctree (table of contents tree) unlike mkdocs. But as far as I have seen in the documentation and forms, sphinx only supports toctrees in .rst files. So, as we move forward, we will run into confusion with using markdown files with normal pages and using rst files with pages that require sub-chapters. I suggest we completely move towards .rst to avoid any confusion.
P.S. If there was a specific reason you used markdown instead of rst, please mention
The text was updated successfully, but these errors were encountered:
@jjscheel There is one issue that I noticed in using markdown with Sphinx.
Right now there is no subchapter in the index on the left bar. But as we proceed, we will need that in our docs. Each subsection requires its own
toctree
(table of contents tree) unlike mkdocs. But as far as I have seen in the documentation and forms, sphinx only supports toctrees in.rst
files. So, as we move forward, we will run into confusion with using markdown files with normal pages and using rst files with pages that require sub-chapters. I suggest we completely move towards.rst
to avoid any confusion.P.S. If there was a specific reason you used markdown instead of rst, please mention
The text was updated successfully, but these errors were encountered: