Skip to content

Commit

Permalink
Remove readthedocs config and use pip-compile to nail down deps
Browse files Browse the repository at this point in the history
  • Loading branch information
tmadlener committed Jan 17, 2024
1 parent 39ed305 commit 19135c3
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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 \
Expand Down
32 changes: 0 additions & 32 deletions .readthedocs.yml

This file was deleted.

7 changes: 7 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
"sphinx.ext.napoleon",
"myst_parser",
"breathe",
"sphinx_copybutton",
]

source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
Expand Down Expand Up @@ -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/.*$'
5 changes: 5 additions & 0 deletions doc/requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
breathe
myst-parser
sphinx
sphinx_rtd_theme
sphinx_copybutton
86 changes: 80 additions & 6 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 19135c3

Please sign in to comment.