summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2020-01-21 22:38:03 -0500
committerJason R. Coombs <jaraco@jaraco.com>2020-01-21 22:45:28 -0500
commit641e088d193142f236d69c78d272cf7ece0d693c (patch)
tree13715d12e91e47ed450abd5475e736189743666c
parentb2845edf4b23ee240a00fe28bd37ab359678d1ae (diff)
downloadpython-setuptools-git-641e088d193142f236d69c78d272cf7ece0d693c.tar.gz
Move docs dependencies into package metadata and use same technique as jaraco/skeleton to build docs in tox and rtd.
-rw-r--r--.github/workflows/python-tests.yml2
-rw-r--r--.readthedocs.yml5
-rw-r--r--docs/requirements.txt5
-rw-r--r--setup.cfg7
-rw-r--r--tox.ini10
5 files changed, 16 insertions, 13 deletions
diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml
index 60765b52..e3663cf0 100644
--- a/.github/workflows/python-tests.yml
+++ b/.github/workflows/python-tests.yml
@@ -55,7 +55,7 @@ jobs:
uses: actions/cache@v1
with:
path: ~/.cache/pip
- key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}-${{ hashFiles('setup.cfg') }}-${{ hashFiles('tox.ini') }}
+ key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
restore-keys: |
${{ runner.os }}-pip-
${{ runner.os }}-
diff --git a/.readthedocs.yml b/.readthedocs.yml
index 3aef6b6b..7b994a35 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -1,4 +1,5 @@
python:
version: 3
- requirements_file: docs/requirements.txt
- pip_install: false
+ extra_requirements:
+ - docs
+ pip_install: true
diff --git a/docs/requirements.txt b/docs/requirements.txt
deleted file mode 100644
index bc27165b..00000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-sphinx!=1.8.0
-rst.linker>=1.9
-jaraco.packaging>=6.1
-
-setuptools>=34
diff --git a/setup.cfg b/setup.cfg
index 87c25a62..bc34b22c 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -55,8 +55,10 @@ exclude = *.tests
[options.extras_require]
ssl =
wincertstore==0.2; sys_platform=='win32'
+
certs =
certifi==2016.9.26
+
tests =
mock
pytest-flake8
@@ -70,3 +72,8 @@ tests =
paver; python_version>="3.6"
futures; python_version=="2.7"
pip>=19.1 # For proper file:// URLs support.
+
+docs =
+ sphinx
+ jaraco.packaging>=6.1
+ rst.linker>=1.9
diff --git a/tox.ini b/tox.ini
index a5ce930f..2164599f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -44,12 +44,12 @@ skip_install=True
commands=codecov -X gcov --file {toxworkdir}/coverage.xml
[testenv:docs]
-deps = -r{toxinidir}/docs/requirements.txt
-skip_install=True
+extras =
+ docs
+ testing
+changedir = docs
commands =
- python -m bootstrap
- sphinx-build -W -b html -d {envtmpdir}/doctrees docs docs/build/html
- sphinx-build -W -b man -d {envtmpdir}/doctrees docs docs/build/man
+ python -m sphinx . {toxinidir}/build/html
[coverage:run]
source=