diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml index a8adc4d..e4cf23d 100644 --- a/.github/workflows/pr.yaml +++ b/.github/workflows/pr.yaml @@ -41,7 +41,6 @@ jobs: permissions: contents: read with: - pre-build-command: sphinx-apidoc --force -o docs/source/api_generated biosimdb_interface build-dir: build timeout-minutes: 15 diff --git a/.github/workflows/weekly-docs.yaml b/.github/workflows/weekly-docs.yaml index bbe8c38..bc9508b 100644 --- a/.github/workflows/weekly-docs.yaml +++ b/.github/workflows/weekly-docs.yaml @@ -19,7 +19,6 @@ jobs: permissions: contents: read with: - pre-build-command: sphinx-apidoc --force -o docs/source/api_generated biosimdb_interface build-dir: build os: '["ubuntu-26.04", "macos-26", "windows-2025-vs2026"]' python-versions: '["3.12", "3.13", "3.14"]' diff --git a/.gitignore b/.gitignore index 775f939..ad827aa 100644 --- a/.gitignore +++ b/.gitignore @@ -172,7 +172,7 @@ cython_debug/ .pypirc # docs -docs/source/apidoc/ +docs/source/reference/ docs/build/ #tests @@ -181,3 +181,4 @@ docs/build/ #scripts run_commands.sh +docs/source/api_generated/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 44a4921..80ef0fc 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,9 +4,6 @@ build: os: ubuntu-24.04 tools: python: "3.13" - jobs: - pre_build: - - sphinx-apidoc --force -o docs/source/api_generated biosimdb_interface sphinx: configuration: docs/source/conf.py diff --git a/docs/Makefile b/docs/Makefile index 170325a..d0c3cbf 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -18,11 +18,3 @@ help: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: api-docs html - -api-docs: - $(SPHINXAPIDOC) --force -o "$(SOURCEDIR)/api_generated" ../biosimdb_interface - -html: api-docs - $(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index 2e078be..0000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,9 +0,0 @@ -API Reference -============= - -Reference to the ``biosimdb-interface`` python API. - -.. toctree:: - :maxdepth: 2 - - api_generated/modules diff --git a/docs/source/api_generated/biosimdb_interface.auth.rst b/docs/source/api_generated/biosimdb_interface.auth.rst deleted file mode 100644 index 47d29d1..0000000 --- a/docs/source/api_generated/biosimdb_interface.auth.rst +++ /dev/null @@ -1,37 +0,0 @@ -biosimdb\_interface.auth package -================================ - -Submodules ----------- - -biosimdb\_interface.auth.community\_invite module -------------------------------------------------- - -.. automodule:: biosimdb_interface.auth.community_invite - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.auth.routes module --------------------------------------- - -.. automodule:: biosimdb_interface.auth.routes - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.auth.services module ----------------------------------------- - -.. automodule:: biosimdb_interface.auth.services - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.auth - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.core.rst b/docs/source/api_generated/biosimdb_interface.core.rst deleted file mode 100644 index c710d5b..0000000 --- a/docs/source/api_generated/biosimdb_interface.core.rst +++ /dev/null @@ -1,45 +0,0 @@ -biosimdb\_interface.core package -================================ - -Submodules ----------- - -biosimdb\_interface.core.cancellation module --------------------------------------------- - -.. automodule:: biosimdb_interface.core.cancellation - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.core.error\_handlers module ------------------------------------------------ - -.. automodule:: biosimdb_interface.core.error_handlers - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.core.errors module --------------------------------------- - -.. automodule:: biosimdb_interface.core.errors - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.core.workflows module ------------------------------------------ - -.. automodule:: biosimdb_interface.core.workflows - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.core - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.extract.rst b/docs/source/api_generated/biosimdb_interface.extract.rst deleted file mode 100644 index 0f99d73..0000000 --- a/docs/source/api_generated/biosimdb_interface.extract.rst +++ /dev/null @@ -1,37 +0,0 @@ -biosimdb\_interface.extract package -=================================== - -Submodules ----------- - -biosimdb\_interface.extract.routes module ------------------------------------------ - -.. automodule:: biosimdb_interface.extract.routes - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.extract.services module -------------------------------------------- - -.. automodule:: biosimdb_interface.extract.services - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.extract.validation module ---------------------------------------------- - -.. automodule:: biosimdb_interface.extract.validation - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.extract - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.home.rst b/docs/source/api_generated/biosimdb_interface.home.rst deleted file mode 100644 index b61e1f6..0000000 --- a/docs/source/api_generated/biosimdb_interface.home.rst +++ /dev/null @@ -1,21 +0,0 @@ -biosimdb\_interface.home package -================================ - -Submodules ----------- - -biosimdb\_interface.home.routes module --------------------------------------- - -.. automodule:: biosimdb_interface.home.routes - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.home - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.invenio.rst b/docs/source/api_generated/biosimdb_interface.invenio.rst deleted file mode 100644 index d917075..0000000 --- a/docs/source/api_generated/biosimdb_interface.invenio.rst +++ /dev/null @@ -1,37 +0,0 @@ -biosimdb\_interface.invenio package -=================================== - -Submodules ----------- - -biosimdb\_interface.invenio.client module ------------------------------------------ - -.. automodule:: biosimdb_interface.invenio.client - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.invenio.multipart module --------------------------------------------- - -.. automodule:: biosimdb_interface.invenio.multipart - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.invenio.progress module -------------------------------------------- - -.. automodule:: biosimdb_interface.invenio.progress - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.invenio - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.rst b/docs/source/api_generated/biosimdb_interface.rst deleted file mode 100644 index 2986763..0000000 --- a/docs/source/api_generated/biosimdb_interface.rst +++ /dev/null @@ -1,26 +0,0 @@ -biosimdb\_interface package -=========================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - biosimdb_interface.auth - biosimdb_interface.core - biosimdb_interface.extract - biosimdb_interface.home - biosimdb_interface.invenio - biosimdb_interface.schema - biosimdb_interface.submit - biosimdb_interface.uploads - biosimdb_interface.webform - -Module contents ---------------- - -.. automodule:: biosimdb_interface - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.schema.rst b/docs/source/api_generated/biosimdb_interface.schema.rst deleted file mode 100644 index e5716b8..0000000 --- a/docs/source/api_generated/biosimdb_interface.schema.rst +++ /dev/null @@ -1,37 +0,0 @@ -biosimdb\_interface.schema package -================================== - -Submodules ----------- - -biosimdb\_interface.schema.helpers module ------------------------------------------ - -.. automodule:: biosimdb_interface.schema.helpers - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.schema.invenio module ------------------------------------------ - -.. automodule:: biosimdb_interface.schema.invenio - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.schema.webform module ------------------------------------------ - -.. automodule:: biosimdb_interface.schema.webform - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.schema - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.submit.rst b/docs/source/api_generated/biosimdb_interface.submit.rst deleted file mode 100644 index 20555c5..0000000 --- a/docs/source/api_generated/biosimdb_interface.submit.rst +++ /dev/null @@ -1,21 +0,0 @@ -biosimdb\_interface.submit package -================================== - -Submodules ----------- - -biosimdb\_interface.submit.routes module ----------------------------------------- - -.. automodule:: biosimdb_interface.submit.routes - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.submit - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.uploads.rst b/docs/source/api_generated/biosimdb_interface.uploads.rst deleted file mode 100644 index 696af96..0000000 --- a/docs/source/api_generated/biosimdb_interface.uploads.rst +++ /dev/null @@ -1,37 +0,0 @@ -biosimdb\_interface.uploads package -=================================== - -Submodules ----------- - -biosimdb\_interface.uploads.to\_invenio module ----------------------------------------------- - -.. automodule:: biosimdb_interface.uploads.to_invenio - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.uploads.to\_server module ---------------------------------------------- - -.. automodule:: biosimdb_interface.uploads.to_server - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.uploads.utils module ----------------------------------------- - -.. automodule:: biosimdb_interface.uploads.utils - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.uploads - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/biosimdb_interface.webform.rst b/docs/source/api_generated/biosimdb_interface.webform.rst deleted file mode 100644 index 772acbb..0000000 --- a/docs/source/api_generated/biosimdb_interface.webform.rst +++ /dev/null @@ -1,37 +0,0 @@ -biosimdb\_interface.webform package -=================================== - -Submodules ----------- - -biosimdb\_interface.webform.conversion module ---------------------------------------------- - -.. automodule:: biosimdb_interface.webform.conversion - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.webform.routes module ------------------------------------------ - -.. automodule:: biosimdb_interface.webform.routes - :members: - :show-inheritance: - :undoc-members: - -biosimdb\_interface.webform.services module -------------------------------------------- - -.. automodule:: biosimdb_interface.webform.services - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: biosimdb_interface.webform - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/api_generated/modules.rst b/docs/source/api_generated/modules.rst deleted file mode 100644 index 012268d..0000000 --- a/docs/source/api_generated/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -biosimdb_interface -================== - -.. toctree:: - :maxdepth: 4 - - biosimdb_interface diff --git a/docs/source/conf.py b/docs/source/conf.py index 9fd58c0..9891506 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,33 +6,50 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information +import importlib.metadata import warnings project = "biosimdb-interface" copyright = "2026, CCPBioSim" -release = "2.1.1" +release = importlib.metadata.version("biosimdb-interface") # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ - "sphinx.ext.autosummary", - "sphinx.ext.autodoc", "sphinx.ext.mathjax", "sphinx.ext.viewcode", "sphinx.ext.napoleon", "sphinx.ext.intersphinx", "sphinx.ext.extlinks", - "nbsphinx", - "sphinx_copybutton", + "autoapi.extension", ] -autosummary_generate = True +# Napoleon: Google-style docstrings napoleon_google_docstring = True napoleon_numpy_docstring = False -napoleon_use_param = False +napoleon_use_param = True napoleon_use_ivar = True +# API reference generated from the source by sphinx-autoapi +autoapi_dirs = ["../../biosimdb_interface"] +autoapi_root = "reference" +autoapi_add_toctree_entry = False +autoapi_member_order = "groupwise" +# Include the __init__ docstring, where the constructor arguments are documented +autoapi_python_class_content = "both" +autoapi_options = [ + "members", + "undoc-members", + "show-inheritance", + "show-module-summary", +] + +# Show type hints in the parameter list rather than the signature +autodoc_typehints = "description" +add_module_names = False +python_maximum_signature_line_length = 88 + templates_path = ["_templates"] exclude_patterns = [] @@ -40,12 +57,9 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "furo" +html_theme = "ccpbiosim_sphinx_theme" +html_context = {"github_repo": "biosimdb-interface"} html_static_path = ["_static"] -html_theme_options = { - "dark_logo": "logos/biosimdb-logo-white.png", - "light_logo": "logos/biosimdb-logo-black.png", -} html_css_files = [ "styles.css", ] diff --git a/docs/source/index.rst b/docs/source/index.rst index 88a08d8..9e240b5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,40 +1,65 @@ -.. CCPBioSim-Python-Template documentation master file, created by - sphinx-quickstart on Wed Dec 10 16:51:51 2025. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +:html_theme.sidebar_secondary.remove: -BioSimDB Interface +biosimdb-interface ================== -``biosimdb-interface`` is available at http://github.com/CCPBioSim/biosimdb-interface +.. ccpbiosim-hero:: + :logo-light: _static/logos/biosimdb-logo-black.png + :logo-dark: _static/logos/biosimdb-logo-white.png + :logo-alt: BioSimDB logo + :tagline: biosimdb-interface + :button: biosimdb_intro | Get started + :github: CCPBioSim/biosimdb-interface -.. image:: /_static/logos/biosimdb-logo-black.png - :width: 250px - :align: center - :class: only-light - -.. image:: /_static/logos/biosimdb-logo-white.png - :width: 250px - :align: center - :class: only-dark + A web interface for extracting simulation metadata and uploading it to BioSimDB A web interface for extracting simulation metadata and uploading it to the `BioSimDB `_ community data collection, hosted by PSDI. +Explore the documentation +------------------------- + +.. grid:: 1 2 2 2 + :gutter: 3 + + .. grid-item-card:: 🗄️ Access to BioSimDB + :link: biosimdb_intro + :link-type: doc + + Use the hosted webform to submit simulations to BioSimDB. + + .. grid-item-card:: 🖥️ Run your own Interface Instance + :link: interface_instance_intro + :link-type: doc + + Install, configure and run your own instance. + + .. grid-item-card:: 👩‍💻 Contributing + :link: contributing + :link-type: doc + + Setting up a development environment and contributing. + + .. grid-item-card:: 📖 API + :link: reference/biosimdb_interface/index + :link-type: doc + + Reference for the biosimdb-interface package. + .. toctree:: :maxdepth: 2 - :caption: Contents: + :hidden: - biosimdb_intro - interface_instance_intro - contributing - api + Access to BioSimDB + Run your own Instance + Contributing + API Funding -======= +------- -Contributors to biosim-schema were supported by +Contributors to biosimdb-interface were supported by .. image:: _static/logos/psdi-logo.png :height: 100px @@ -47,9 +72,3 @@ Contributors to biosim-schema were supported by .. image:: _static/logos/CCPBioSim-logo.png :height: 100px :target: https://www.ccpbiosim.ac.uk/ - -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` diff --git a/pyproject.toml b/pyproject.toml index 6d482f4..64b8077 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -68,9 +68,8 @@ pre-commit = [ docs = [ "sphinx>=9,<10", - "nbsphinx>=0.9,<1.0", - "sphinx_copybutton>=0.5,<1.0", - "furo>=2025.12.19,<2026.0", + "sphinx-autoapi>=3.8,<4.0", + "ccpbiosim-sphinx-theme>=1.3.1,<2.0", "markupsafe>=3.0,<4.0" ]