Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup reproducible docs builds using pip-tools #1969

Merged
merged 4 commits into from
Aug 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
furo
myst-parser
setuptools-scm
sphinx
sphinxcontrib-programoutput
101 changes: 96 additions & 5 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,96 @@
furo >= 2021.7.5b38
myst-parser >= 0.15.1
setuptools-scm >= 6.0.1
Sphinx >= 4.1.1
sphinxcontrib-programoutput >= 0.17
#
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile --allow-unsafe --strip-extras docs/requirements.in
#
alabaster==0.7.13
# via sphinx
babel==2.12.1
# via sphinx
beautifulsoup4==4.12.2
# via furo
certifi==2023.7.22
# via requests
charset-normalizer==3.2.0
# via requests
docutils==0.20.1
# via
# myst-parser
# sphinx
furo==2023.8.17
# via -r docs/requirements.in
idna==3.4
# via requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.2
# 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 docs/requirements.in
packaging==23.1
# via
# setuptools-scm
# sphinx
pygments==2.16.1
# via
# furo
# sphinx
pyyaml==6.0.1
# via myst-parser
requests==2.31.0
# via sphinx
setuptools-scm==7.1.0
# via -r docs/requirements.in
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.4.1
# via beautifulsoup4
sphinx==7.2.2
# via
# -r docs/requirements.in
# furo
# myst-parser
# sphinx-basic-ng
# sphinxcontrib-applehelp
# sphinxcontrib-devhelp
# sphinxcontrib-htmlhelp
# sphinxcontrib-programoutput
# sphinxcontrib-qthelp
# sphinxcontrib-serializinghtml
sphinx-basic-ng==1.0.0b2
# via furo
sphinxcontrib-applehelp==1.0.7
# via sphinx
sphinxcontrib-devhelp==1.0.5
# via sphinx
sphinxcontrib-htmlhelp==2.0.4
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-programoutput==0.17
# via -r docs/requirements.in
sphinxcontrib-qthelp==1.0.6
# via sphinx
sphinxcontrib-serializinghtml==1.1.8
# via sphinx
typing-extensions==4.7.1
# via setuptools-scm
urllib3==2.0.4
# via requests

# The following packages are considered to be unsafe in a requirements file:
setuptools==68.1.2
# via setuptools-scm
5 changes: 5 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ commands =
twine check --strict {envtmpdir}{/}*
skip_install = true

[testenv:pip-compile-docs]
description = compile requirements for the documentation
commands_pre =
commands = python -m piptools compile --strip-extras --allow-unsafe --quiet docs/requirements.in {posargs}

[testenv:build-docs]
description = build the documentation
deps =
Expand Down
Loading