The index file in a Sphinx project should not be .rst #285

Activity

1. bast

   changed the title [-]The index file does not have to be .rst[/-] [+]The index file in a Sphinx project does not have to be .rst[/+] on Oct 2, 2023
2. bast commented on Oct 2, 2023

   

   bast

   on Oct 2, 2023

   MemberAuthor

   More actions

   It will be simpler to introduce Sphinx with "pure" md (as interpreted by MyST) instead of using md everywhere except for the index file.
3. bast

   changed the title [-]The index file in a Sphinx project does not have to be .rst[/-] [+]The index file in a Sphinx project should not be .rst[/+] on Mar 20, 2024
4. bast commented on Mar 24, 2024

   

   bast

   on Mar 24, 2024

   MemberAuthor

   More actions

   One complication is that sphinx-quickstart always generates an index.rst and we would have to change it to index.md afterwards.
5. frankier

   added

   idea

   and removed

   idea

   on Mar 6, 2026
6. frankier

   assigned

   mmesiti

   on Mar 9, 2026
7. mmesiti commented on Mar 9, 2026

   

   mmesiti

   on Mar 9, 2026

   Last edited by mmesiti

   Contributor

   More actions

   This seems relevant: https://myst-parser.readthedocs.io/en/latest/syntax/organising_content.html, in particular:
   https://myst-parser.readthedocs.io/en/latest/syntax/organising_content.html#using-toctree-to-include-other-documents-as-children
8. mmesiti commented on Mar 23, 2026

   

   mmesiti

   on Mar 23, 2026

   Contributor

   More actions

   This should be addressed in #323. Close - with calm - if that's the case.