Skip to content

Commit e21a7b4

Browse files
committed
DOC: build dev documentation
This PR builds the development documentation with sphinx. It required moving the existing files from the root directory to the ``doc`` directory.
1 parent 4d28be9 commit e21a7b4

File tree

8 files changed

+5
-114
lines changed

8 files changed

+5
-114
lines changed

doc/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
'sphinx.ext.autodoc',
3434
'numpydoc',
3535
'sphinx.ext.mathjax',
36+
'myst_parser',
3637
]
3738

3839
# Add any paths that contain templates here, relative to this directory.

doc/source/doc_developer/building_with_poetry.rst

Lines changed: 0 additions & 64 deletions
This file was deleted.

doc/source/doc_developer/getting_the_code.rst

Lines changed: 0 additions & 48 deletions
This file was deleted.

doc/source/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,9 @@ Development
6565
.. toctree::
6666
:maxdepth: 1
6767

68-
doc_developer/getting_the_code
69-
doc_developer/building_with_poetry
68+
dev/getting_the_code.md
69+
dev/building_with_poetry.md
70+
dev/running_the_benchmarks.md
7071

7172
.. include:: release-notes.rst
7273

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ pytest = "^8.0"
4848
sphinx = "^7.0"
4949
numpydoc = "^1.5"
5050
pydata-sphinx-theme = "^0.14.3"
51+
myst-parser = "^2.0.0"
5152

5253

5354

0 commit comments

Comments
 (0)