Commit 112b0973 authored by Ayres, Andrew's avatar Ayres, Andrew
Browse files

Merge branch '7-set-up-read-the-docs-for-package' into 'main' 

Resolve "Set up read the docs for package"

Closes #7

See merge request ndip/public-packages/nova-galaxy!4
parents e85e0012 8e4b7819

.gitlab-ci.yml

+26 −0
Original line number Diff line number Diff line
@@ -92,3 +92,29 @@ package-build: 
  when: manual

  tags:

    - rse-multi-builder



docs-test:

  stage: test

  script:

    - docker build -f dockerfiles/Dockerfile --target source -t image .

    - docker run -u `id -u`:`id -g` image bash build_docs.sh

  tags:

    - rse-multi-builder



docs-publish:

  stage: package

  rules:

    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

      when: always

    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'

      when: never

    - when: manual

  script:

    - |

      if [ -z "$READTHEDOCS_WEBHOOK_SECRET" ] || [ -z "$READTHEDOCS_WEBHOOK_URL" ]; then

        echo "Error: READTHEDOCS_WEBHOOK_SECRET and/or READTHEDOCS_WEBHOOK_URL is not set."

        exit 1

      fi

    - curl -X POST -d "branches=latest" -d "token=${READTHEDOCS_WEBHOOK_SECRET}" -d "default_branch=${CI_COMMIT_BRANCH}" ${READTHEDOCS_WEBHOOK_URL}

  tags:

    - rse-multi-builder

build_docs.sh

0 → 100755
+1 −0
Original line number Diff line number Diff line 
poetry run sphinx-build -M html docs docs/_build
 
 No newline at end of file

dockerfiles/Dockerfile

+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ RUN poetry install 
RUN poetry build --format=wheel



RUN chmod og+rwX /poetry

RUN chmod og+rwX /src

RUN chmod og+rwX -R /src

docs/api_reference.rst

0 → 100644
+22 −0
Original line number Diff line number Diff line 
.. _api_reference:



API Reference

=============



.. automodule:: nova.galaxy

   :members:



.. automodule:: nova.galaxy.data_store

   :members:



.. automodule:: nova.galaxy.dataset

   :members:



.. automodule:: nova.galaxy.parameters

   :members:



.. automodule:: nova.galaxy.outputs

   :members:



.. automodule:: nova.galaxy.tool

   :members:
 
 No newline at end of file

docs/conf.py

0 → 100644
+17 −0
Original line number Diff line number Diff line 
"""Configuration file for the Sphinx documentation builder."""



import tomli



project = "nova-galaxy"

copyright = "2023, ORNL"

author = "Andrew Ayres"

with open("../pyproject.toml", "rb") as toml_file:

    toml_dict = tomli.load(toml_file)

    release = toml_dict["tool"]["poetry"]["version"]



extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.viewcode", "sphinx_rtd_theme"]



templates_path = ["_templates"]

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]



html_theme = "sphinx_rtd_theme"