Merge pull request #107 from Kai-Striega/doc/move-docs-to-docs-folder

DOC: build dev documentation
numpy · Mar 21, 2024 · 6896008 · 6896008
2 parents 4d28be9 + e21a7b4
commit 6896008
Show file tree

Hide file tree

Showing 8 changed files with 5 additions and 114 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -33,6 +33,7 @@
     'sphinx.ext.autodoc',
     'numpydoc',
     'sphinx.ext.mathjax',
+    'myst_parser',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/doc_developer/building_with_poetry.md → doc/source/dev/building_with_poetry.md b/doc_developer/building_with_poetry.md → doc/source/dev/building_with_poetry.md
diff --git a/doc_developer/getting_the_code.md → doc/source/dev/getting_the_code.md b/doc_developer/getting_the_code.md → doc/source/dev/getting_the_code.md
diff --git a/doc_developer/running_the_benchmarks.md → doc/source/dev/running_the_benchmarks.md b/doc_developer/running_the_benchmarks.md → doc/source/dev/running_the_benchmarks.md
diff --git a/doc/source/doc_developer/building_with_poetry.rst b/doc/source/doc_developer/building_with_poetry.rst
diff --git a/doc/source/doc_developer/getting_the_code.rst b/doc/source/doc_developer/getting_the_code.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -65,8 +65,9 @@ Development
 .. toctree::
    :maxdepth: 1
 
-   doc_developer/getting_the_code
-   doc_developer/building_with_poetry
+   dev/getting_the_code.md
+   dev/building_with_poetry.md
+   dev/running_the_benchmarks.md
 
 .. include:: release-notes.rst
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -48,6 +48,7 @@ pytest = "^8.0"
 sphinx = "^7.0"
 numpydoc = "^1.5"
 pydata-sphinx-theme = "^0.14.3"
+myst-parser = "^2.0.0"