Skip to content

sphinx: use markdown as index, no quickstart#323

Draft
mmesiti wants to merge 2 commits intocoderefinery:mainfrom
mmesiti:no-quickstart-full-myst
Draft

sphinx: use markdown as index, no quickstart#323
mmesiti wants to merge 2 commits intocoderefinery:mainfrom
mmesiti:no-quickstart-full-myst

Conversation

@mmesiti
Copy link
Collaborator

@mmesiti mmesiti commented Mar 13, 2026

This would address #285 and #291

Note: removed the use of quickstart, since it would create an index in ReST format. But this requires us creating also conf.py manually.
This can be done: the minimal example in this PR works.
But it is very minimal: sphinx-quickstart would set these variables too:

  • copyright
  • templates_path
  • exclude_patterns, with more paths which might be irrelevant for most people
  • html_static_path
    I am not sure we should not set some of these variables too in the example.

@mmesiti mmesiti requested a review from frankier March 13, 2026 12:33
- removed mentions of ReST
- amended toctree directives in all exercises
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

Successfully merging this pull request may close these issues.

1 participant