Rename doc

MPI-IS · Oct 24, 2024 · 370a1c3 · 370a1c3
1 parent 9cc24c4
commit 370a1c3
Show file tree

Hide file tree

Showing 17 changed files with 11 additions and 11 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -16,12 +16,12 @@ jobs:
           pip install sphinx sphinx_rtd_theme myst_parser faraday-retry
       - name: Sphinx build
         run: |
-          sphinx-build doc/source doc/build/html
+          sphinx-build docs/source doc/build/html
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
         with:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: doc/build/html
+          publish_dir: docs/build/html
           force_orphan: true
diff --git a/.gitignore b/.gitignore
@@ -35,14 +35,14 @@ build
 # XML reports
 TEST*.xml
 
-doc/source/generated/
+docs/source/generated/
 
-doc/source/tutorials/outputs/
+docs/source/tutorials/outputs/
 
 coverage.xml
 
 CRep_output/
 
 JointCRep_output/
 
-doc/source/tutorials/tutorial_outputs/
+docs/source/tutorials/tutorial_outputs/
diff --git a/README.md b/README.md
@@ -80,12 +80,12 @@ To run the tests:
 The documentation can be built with *Sphinx* by running:
 
 ```bash
-    cd doc
+    cd docs
     make html
 ```
 
 The tutorials are then displayed in the left sidebar of the generated HTML documentation. They
-can also be accessed directly from the [tutorials](doc/source/tutorials) folder.
+can also be accessed directly from the [tutorials](docs/source/tutorials) folder.
 
 ## Authors
 

diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
diff --git a/doc/source/api.rst → docs/source/api.rst b/doc/source/api.rst → docs/source/api.rst
diff --git a/doc/source/conf.py → docs/source/conf.py b/doc/source/conf.py → docs/source/conf.py
@@ -35,17 +35,17 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "sphinx.ext.autodoc",  # pull doc from docstrings
+    "sphinx.ext.autodoc",  # pull docs from docstrings
     # 'sphinx_autodoc_typehints',  # type hints # TODO: remove this from reqs
     "sphinx.ext.intersphinx",  # link to other projects
     "sphinx.ext.todo",  # support TODOs
     "sphinx.ext.ifconfig",  # include stuff based on configuration
     "sphinx.ext.viewcode",  # add source code
     # 'myst_parser',  # add MD files # not needed if myst_nb is used!
-    "sphinx.ext.autosummary",  # pull doc from docstrings
+    "sphinx.ext.autosummary",  # pull docs from docstrings
     # 'nbsphinx',  # add Jupyter notebooks
     "myst_nb",  # add Jupyter notebooks
-    "sphinx.ext.napoleon",  # 'sphinxcontrib.napoleon' is deprecated  # Google style doc
+    "sphinx.ext.napoleon",  # 'sphinxcontrib.napoleon' is deprecated  # Google style docs
 ]
 autodoc_default_options = {
     "members": True,  # when set to True, Sphinx will automatically document all members

diff --git a/doc/source/index.rst → docs/source/index.rst b/doc/source/index.rst → docs/source/index.rst
diff --git a/doc/source/tutorials/ACD.ipynb → docs/source/tutorials/ACD.ipynb b/doc/source/tutorials/ACD.ipynb → docs/source/tutorials/ACD.ipynb
diff --git a/doc/source/tutorials/CRep.ipynb → docs/source/tutorials/CRep.ipynb b/doc/source/tutorials/CRep.ipynb → docs/source/tutorials/CRep.ipynb
diff --git a/doc/source/tutorials/DynCRep.ipynb → docs/source/tutorials/DynCRep.ipynb b/doc/source/tutorials/DynCRep.ipynb → docs/source/tutorials/DynCRep.ipynb
diff --git a/doc/source/tutorials/JointCRep.ipynb → docs/source/tutorials/JointCRep.ipynb b/doc/source/tutorials/JointCRep.ipynb → docs/source/tutorials/JointCRep.ipynb
diff --git a/doc/source/tutorials/MTCOV.ipynb → docs/source/tutorials/MTCOV.ipynb b/doc/source/tutorials/MTCOV.ipynb → docs/source/tutorials/MTCOV.ipynb
diff --git a/doc/source/tutorials/create_syn_ACD.ipynb → docs/source/tutorials/create_syn_ACD.ipynb b/doc/source/tutorials/create_syn_ACD.ipynb → docs/source/tutorials/create_syn_ACD.ipynb
diff --git a/...nputs/theta_GT_ACD_for_initialization.npz → ...nputs/theta_GT_ACD_for_initialization.npz b/...nputs/theta_GT_ACD_for_initialization.npz → ...nputs/theta_GT_ACD_for_initialization.npz
diff --git a/...urce/tutorials/network_with_anomalies.csv → ...urce/tutorials/network_with_anomalies.csv b/...urce/tutorials/network_with_anomalies.csv → ...urce/tutorials/network_with_anomalies.csv
diff --git a/tests/test_notebooks.py b/tests/test_notebooks.py
@@ -21,7 +21,7 @@ def run_notebook(self, notebook_name):
         # Get the absolute path of the notebook dynamically
         root_path = Path(__file__).parent.parent
         notebook_path = (
-            root_path / "doc" / "source" / "tutorials" / f"{notebook_name}.ipynb"
+            root_path / "docs" / "source" / "tutorials" / f"{notebook_name}.ipynb"
         )
 
         # Store the current directory