diff --git a/data_collections_api/__init__.py b/data_collections_api/__init__.py index 7ea42c2..3ff3fe8 100644 --- a/data_collections_api/__init__.py +++ b/data_collections_api/__init__.py @@ -3,4 +3,4 @@ from __future__ import annotations __version__ = "0.1.0" -__author__ = "Jacob Wilkins, Elliot Kasoar, Jas Kalaya, Alin Elena" +__author__ = "Jacob Wilkins, Elliot Kasoar, Jas Kalayan, Alin Elena" diff --git a/docs/source/conf.py b/docs/source/conf.py index e2c0d2f..574d86b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -38,13 +38,16 @@ "sphinx.ext.mathjax", "sphinx.ext.viewcode", "sphinxcontrib.contentui", - "myst_parser", + "myst_nb", ] +nb_execution_mode = "off" + source_suffix = { ".rst": "restructuredtext", - ".txt": "markdown", - ".md": "markdown", + ".txt": "myst-nb", + ".md": "myst-nb", + ".ipynb": "myst-nb", } apidoc_modules = [ diff --git a/notebooks/deposition_tutorial/images/screenshot01.png b/docs/source/deposition_tutorial/images/screenshot01.png similarity index 100% rename from notebooks/deposition_tutorial/images/screenshot01.png rename to docs/source/deposition_tutorial/images/screenshot01.png diff --git a/notebooks/deposition_tutorial/images/screenshot02.png b/docs/source/deposition_tutorial/images/screenshot02.png similarity index 100% rename from notebooks/deposition_tutorial/images/screenshot02.png rename to docs/source/deposition_tutorial/images/screenshot02.png diff --git a/notebooks/deposition_tutorial/images/screenshot03.png b/docs/source/deposition_tutorial/images/screenshot03.png similarity index 100% rename from notebooks/deposition_tutorial/images/screenshot03.png rename to docs/source/deposition_tutorial/images/screenshot03.png diff --git a/notebooks/deposition_tutorial/images/screenshot04.png b/docs/source/deposition_tutorial/images/screenshot04.png similarity index 100% rename from notebooks/deposition_tutorial/images/screenshot04.png rename to docs/source/deposition_tutorial/images/screenshot04.png diff --git a/docs/source/deposition_tutorial/index.rst b/docs/source/deposition_tutorial/index.rst new file mode 100644 index 0000000..8490169 --- /dev/null +++ b/docs/source/deposition_tutorial/index.rst @@ -0,0 +1,10 @@ +Tutorials +========= + +This contains a list of tutorials on using ``data_collections_api``. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + tutorial diff --git a/notebooks/deposition_tutorial/record.yaml b/docs/source/deposition_tutorial/record.yaml similarity index 100% rename from notebooks/deposition_tutorial/record.yaml rename to docs/source/deposition_tutorial/record.yaml diff --git a/notebooks/deposition_tutorial/tutorial.ipynb b/docs/source/deposition_tutorial/tutorial.ipynb similarity index 100% rename from notebooks/deposition_tutorial/tutorial.ipynb rename to docs/source/deposition_tutorial/tutorial.ipynb diff --git a/docs/source/index.rst b/docs/source/index.rst index 78bccf3..273322b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,5 +15,6 @@ Project to allow simplified editing and construction of Invenio data for the PSD cli schema + deposition_tutorial/index schemas/index API Documentation diff --git a/docs/source/scripts/schema_gen.py b/docs/source/scripts/schema_gen.py index 00bceed..883a62f 100644 --- a/docs/source/scripts/schema_gen.py +++ b/docs/source/scripts/schema_gen.py @@ -29,9 +29,7 @@ :maxdepth: 1 :caption: Schemas: -{schemas} - -""" +{schemas}""" def get_arg_parser() -> argparse.ArgumentParser: diff --git a/pyproject.toml b/pyproject.toml index 6553353..e1eab18 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,8 +41,8 @@ docs = [ "sphinxcontrib-contentui<1.0.0,>=0.2.5", "furo==2025.9.25", "numpydoc>=1.9.0", - "myst-parser", "jsonschema-markdown", + "myst-nb", ] lint = ["pre-commit<5.0.0,>=4.2.0", "ruff==0.13.3", "numpydoc>=0.19.0"] test = ["pytest==8.3.4", "pytest-cov==5.0.0"]