Skip to content

Commit

Permalink
update requirements for building docs and use them to create reproduc…
Browse files Browse the repository at this point in the history
…ible builds in ReadTheDocs

close #25, close #28, close #29, close #30
  • Loading branch information
sastred committed Aug 24, 2023
1 parent 1f19ed0 commit bd52c7c
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 27 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Virtual envs
.venv

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
Change log
==========

[Unreleased]
------------

* Update requirements for building docs and use them to create reproducible builds in ReadTheDocs.

v1.5.0 (2023-06-29)
--------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# language = en

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
28 changes: 28 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
alabaster==0.7.13
Babel==2.12.1
certifi==2023.7.22
charset-normalizer==3.2.0
colorama==0.4.6
docutils==0.18.1
idna==3.4
imagesize==1.4.1
Jinja2==3.1.2
livereload==2.6.3
MarkupSafe==2.1.3
packaging==23.1
Pygments==2.16.1
requests==2.31.0
six==1.16.0
snowballstemmer==2.2.0
Sphinx==7.2.3
sphinx-autobuild==2021.3.14
sphinx-rtd-theme==1.3.0
sphinxcontrib-applehelp==1.0.7
sphinxcontrib-devhelp==1.0.5
sphinxcontrib-htmlhelp==2.0.4
sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.6
sphinxcontrib-serializinghtml==1.1.9
tornado==6.3.3
urllib3==2.0.4
4 changes: 4 additions & 0 deletions readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,7 @@ sphinx:
formats:
- pdf
- epub

python:
install:
- requirements: docs/requirements.txt
26 changes: 0 additions & 26 deletions requirements.txt

This file was deleted.

0 comments on commit bd52c7c

Please sign in to comment.