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

Markdown and RST file ambiguity #3

Open
alitariq4589 opened this issue Jul 9, 2024 · 1 comment
Open

Markdown and RST file ambiguity #3

alitariq4589 opened this issue Jul 9, 2024 · 1 comment
Assignees

Comments

@alitariq4589
Copy link
Collaborator

@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

@alitariq4589
Copy link
Collaborator Author

PR #4 Should solve this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant