From ad14ca41fce11a4fb01f3abe074b5af93ddb8d6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Robert?= Date: Tue, 17 Dec 2024 09:04:29 +0100 Subject: [PATCH] MNT: compile (pin) doc build dependencies --- .github/workflows/idefix-ci-doc.yml | 2 +- .readthedocs.yaml | 2 +- ...ython_requirements.txt => requirements.in} | 17 ++-- doc/requirements.txt | 93 +++++++++++++++++++ 4 files changed, 104 insertions(+), 10 deletions(-) rename doc/{python_requirements.txt => requirements.in} (53%) create mode 100644 doc/requirements.txt diff --git a/.github/workflows/idefix-ci-doc.yml b/.github/workflows/idefix-ci-doc.yml index 72b5dd0b..76276678 100644 --- a/.github/workflows/idefix-ci-doc.yml +++ b/.github/workflows/idefix-ci-doc.yml @@ -19,6 +19,6 @@ jobs: - name: install doxygen run: sudo apt-get install -y doxygen - name: install python dependencies - run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt + run: python -m pip install --exists-action=w --no-cache-dir -r doc/requirements.txt - name: compile documentation run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source doc/html diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7c72516d..5cd367c7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -26,4 +26,4 @@ sphinx: # Optionally declare the Python requirements required to build your docs python: install: - - requirements: doc/python_requirements.txt + - requirements: doc/requirements.txt diff --git a/doc/python_requirements.txt b/doc/requirements.in similarity index 53% rename from doc/python_requirements.txt rename to doc/requirements.in index 35f72dcf..b51d5330 100644 --- a/doc/python_requirements.txt +++ b/doc/requirements.in @@ -3,14 +3,15 @@ # Doxygen https://www.doxygen.nl/download.html # # Install Sphinx and required plugins with the following command -# python -m pip install -r python_requirements.txt +# python -m pip install -r requirements.txt wheel>=0.38.4 # help forward compatibility for pip with old sphinx plugins -sphinx==5.3.0 -sphinx_rtd_theme==1.3.0 -sphinx_git==11.0.0 -breathe==4.34.0 -exhale==0.3.7 -m2r2==0.3.2 -sphinx-copybutton==0.5.2 +sphinx>=5.3.0 +sphinx_rtd_theme>=1.3.0 +sphinx_git>=11.0.0 +breathe>=4.34.0 +exhale>=0.3.7 +m2r2>=0.3.2 +setuptools # see https://github.com/CrossNox/m2r2/issues/63 +sphinx-copybutton>=0.5.2 #sphinxcontrib-applehelp==1.0.7 diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..4b4d5b5d --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,93 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile doc/requirements.in +alabaster==0.7.16 + # via sphinx +babel==2.16.0 + # via sphinx +beautifulsoup4==4.12.3 + # via exhale +breathe==4.34.0 + # via + # -r doc/requirements.in + # exhale +certifi==2024.12.14 + # via requests +charset-normalizer==3.4.0 + # via requests +docutils==0.18.1 + # via + # breathe + # m2r2 + # sphinx + # sphinx-rtd-theme +exhale==0.3.7 + # via -r doc/requirements.in +gitdb==4.0.11 + # via gitpython +gitpython==3.1.43 + # via sphinx-git +idna==3.10 + # via requests +imagesize==1.4.1 + # via sphinx +jinja2==3.1.4 + # via sphinx +lxml==5.3.0 + # via exhale +m2r2==0.3.2 + # via -r doc/requirements.in +markupsafe==3.0.2 + # via jinja2 +mistune==0.8.4 + # via m2r2 +packaging==24.2 + # via sphinx +pygments==2.18.0 + # via sphinx +requests==2.32.3 + # via sphinx +setuptools==75.6.0 + # via -r doc/requirements.in +six==1.17.0 + # via + # exhale + # sphinx-git +smmap==5.0.1 + # via gitdb +snowballstemmer==2.2.0 + # via sphinx +soupsieve==2.6 + # via beautifulsoup4 +sphinx==5.3.0 + # via + # -r doc/requirements.in + # breathe + # exhale + # sphinx-copybutton + # sphinx-git + # sphinx-rtd-theme + # sphinxcontrib-jquery +sphinx-copybutton==0.5.2 + # via -r doc/requirements.in +sphinx-git==11.0.0 + # via -r doc/requirements.in +sphinx-rtd-theme==1.3.0 + # via -r doc/requirements.in +sphinxcontrib-applehelp==2.0.0 + # via sphinx +sphinxcontrib-devhelp==2.0.0 + # via sphinx +sphinxcontrib-htmlhelp==2.1.0 + # via sphinx +sphinxcontrib-jquery==4.1 + # via sphinx-rtd-theme +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==2.0.0 + # via sphinx +sphinxcontrib-serializinghtml==2.0.0 + # via sphinx +urllib3==2.2.3 + # via requests +wheel==0.45.1 + # via -r doc/requirements.in