diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bb6d6f73d..7303c4cf9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,7 +19,6 @@ jobs: steps: - uses: actions/checkout@v4 - - uses: actions/configure-pages@v4 - uses: cvmfs-contrib/github-action-cvmfs@v3 - uses: aidasoft/run-lcg-view@v4 with: @@ -29,6 +28,7 @@ jobs: echo "::group::Install dependencies" python3 -m pip install -r doc/requirements.txt export PATH=/root/.local/bin:$PATH + export PYTHONPATH=/root/.local/lib/python3.10/site-packages:$PYTHONPATH echo -e "::endgroup::\n::group::Build podio" cmake -B build . --install-prefix=$(pwd)/install \ diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 5a50966f2..000000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,32 +0,0 @@ -# .readthedocs.yaml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Set the OS, Python version and other tools you might need -build: - os: ubuntu-22.04 - tools: - python: "3.10" - # You can also specify other tool versions: - # nodejs: "19" - # rust: "1.64" - # golang: "1.19" - -# Build documentation in the "docs/" directory with Sphinx -sphinx: - configuration: doc/conf.py - -# Optionally build your docs in additional formats such as PDF and ePub -# formats: -# - pdf -# - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: doc/requirements.txt diff --git a/doc/conf.py b/doc/conf.py index 5b51b272c..8e32f5047 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -48,6 +48,7 @@ "sphinx.ext.napoleon", "myst_parser", "breathe", + "sphinx_copybutton", ] source_suffix = {".rst": "restructuredtext", ".md": "markdown"} @@ -151,3 +152,9 @@ ) print("Done with python API doc generation") + +# -- multiversion setup ------------------------------------------------------- +mv_tag_whitelist = r'^v[0-9]{2}-[0-9]{2}(-[0-9]{2})?$' +smv_remote_whitelist = r'^(origin)$' +smv_branch_whitelist = r'^(master|docs-on-gh-pages)$' +smv_released_pattern = r'^tags/.*$' diff --git a/doc/requirements.in b/doc/requirements.in new file mode 100644 index 000000000..97bc1a97e --- /dev/null +++ b/doc/requirements.in @@ -0,0 +1,5 @@ +breathe +myst-parser +sphinx +sphinx_rtd_theme +sphinx_copybutton diff --git a/doc/requirements.txt b/doc/requirements.txt index 1b6bb09c0..8da35aaa8 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,80 @@ -breathe -myst-parser -sphinx -sphinx_rtd_theme -sphinx_copybutton -sphinx_multiversion +# +# This file is autogenerated by pip-compile with Python 3.10 +# by the following command: +# +# pip-compile requirements.in +# +alabaster==0.7.16 + # via sphinx +babel==2.14.0 + # via sphinx +breathe==4.35.0 + # via -r requirements.in +certifi==2023.11.17 + # via requests +charset-normalizer==3.3.2 + # via requests +docutils==0.20.1 + # via + # breathe + # myst-parser + # sphinx + # sphinx-rtd-theme +idna==3.6 + # via requests +imagesize==1.4.1 + # via sphinx +jinja2==3.1.3 + # via + # myst-parser + # sphinx +markdown-it-py==3.0.0 + # via + # mdit-py-plugins + # myst-parser +markupsafe==2.1.3 + # via jinja2 +mdit-py-plugins==0.4.0 + # via myst-parser +mdurl==0.1.2 + # via markdown-it-py +myst-parser==2.0.0 + # via -r requirements.in +packaging==23.2 + # via sphinx +pygments==2.17.2 + # via sphinx +pyyaml==6.0.1 + # via myst-parser +requests==2.31.0 + # via sphinx +snowballstemmer==2.2.0 + # via sphinx +sphinx==7.2.6 + # via + # -r requirements.in + # breathe + # myst-parser + # sphinx-copybutton + # sphinx-rtd-theme + # sphinxcontrib-jquery +sphinx-copybutton==0.5.2 + # via -r requirements.in +sphinx-rtd-theme==2.0.0 + # via -r requirements.in +sphinxcontrib-applehelp==1.0.8 + # via sphinx +sphinxcontrib-devhelp==1.0.6 + # via sphinx +sphinxcontrib-htmlhelp==2.0.5 + # via sphinx +sphinxcontrib-jquery==4.1 + # via sphinx-rtd-theme +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==1.0.7 + # via sphinx +sphinxcontrib-serializinghtml==1.1.10 + # via sphinx +urllib3==2.1.0 + # via requests