Skip to content

Commit ff21eb6

Browse files
Jammy2211Jammy2211claude
authored
docs: convert index.rst to MyST .md (#294)
Converts docs/index.rst to docs/index.md and adds `myst_parser` to the Sphinx extensions list (the docs were RST-only previously). The single index page is a thin wrapper around the README. Part of PyAutoLabs/PyAutoFit#1245. Co-authored-by: Jammy2211 <[email protected]> Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]>
1 parent e9ea5de commit ff21eb6

3 files changed

Lines changed: 4 additions & 1 deletion

File tree

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
"sphinx.ext.napoleon",
4040
"sphinx.ext.extlinks",
4141
"numpydoc",
42+
"myst_parser",
4243
]
4344

4445
## Generate autodoc stubs with summaries from code

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```{eval-rst}
2+
.. include:: ../README.rst
3+
```

docs/index.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)