Skip to content

Commit 641e088

Browse files
committed
Move docs dependencies into package metadata and use same technique as jaraco/skeleton to build docs in tox and rtd.
1 parent b2845ed commit 641e088

File tree

5 files changed

+16
-13
lines changed

5 files changed

+16
-13
lines changed

.github/workflows/python-tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
uses: actions/cache@v1
5656
with:
5757
path: ~/.cache/pip
58-
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}-${{ hashFiles('setup.cfg') }}-${{ hashFiles('tox.ini') }}
58+
key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
5959
restore-keys: |
6060
${{ runner.os }}-pip-
6161
${{ runner.os }}-

.readthedocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
python:
22
version: 3
3-
requirements_file: docs/requirements.txt
4-
pip_install: false
3+
extra_requirements:
4+
- docs
5+
pip_install: true

docs/requirements.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

setup.cfg

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,10 @@ exclude = *.tests
5555
[options.extras_require]
5656
ssl =
5757
wincertstore==0.2; sys_platform=='win32'
58+
5859
certs =
5960
certifi==2016.9.26
61+
6062
tests =
6163
mock
6264
pytest-flake8
@@ -70,3 +72,8 @@ tests =
7072
paver; python_version>="3.6"
7173
futures; python_version=="2.7"
7274
pip>=19.1 # For proper file:// URLs support.
75+
76+
docs =
77+
sphinx
78+
jaraco.packaging>=6.1
79+
rst.linker>=1.9

tox.ini

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ skip_install=True
4444
commands=codecov -X gcov --file {toxworkdir}/coverage.xml
4545

4646
[testenv:docs]
47-
deps = -r{toxinidir}/docs/requirements.txt
48-
skip_install=True
47+
extras =
48+
docs
49+
testing
50+
changedir = docs
4951
commands =
50-
python -m bootstrap
51-
sphinx-build -W -b html -d {envtmpdir}/doctrees docs docs/build/html
52-
sphinx-build -W -b man -d {envtmpdir}/doctrees docs docs/build/man
52+
python -m sphinx . {toxinidir}/build/html
5353

5454
[coverage:run]
5555
source=

0 commit comments

Comments
 (0)