Skip to content

Commit cf3ffca

Browse files
committed
Create action to validate docs
1 parent 3ad462e commit cf3ffca

File tree

4 files changed

+25
-23
lines changed

4 files changed

+25
-23
lines changed

.github/workflows/docs.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Validate docs
2+
3+
on:
4+
push:
5+
paths:
6+
- 'docs/**'
7+
8+
jobs:
9+
validate:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-python@v4
15+
with:
16+
python-version: "3.11"
17+
18+
- name: Install build dependencies
19+
run: pip install -r docs/requirements.txt
20+
- name: Rendering HTML documentation
21+
run: sphinx-build -b html docs/ html
22+
- name: Inspect html rendered
23+
run: cat html/index.html

docs/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following HTTP libraries are supported:
1818
- ``boto3``
1919
- ``http.client``
2020
- ``httplib2``
21-
- ``requests`` (both 1.x and 2.x versions)
21+
- ``requests`` (>=2.16.2 versions)
2222
- ``tornado.httpclient``
2323
- ``urllib2``
2424
- ``urllib3``

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def run_tests(self):
6363
"pytest",
6464
"pytest-aiohttp",
6565
"pytest-httpbin",
66-
"requests",
66+
"requests>=2.16.2",
6767
"tornado",
6868
# Needed to un-break httpbin 0.7.0. For httpbin >=0.7.1 and after,
6969
# this pin and the dependency itself can be removed, provided

tox.ini

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -44,27 +44,6 @@ deps =
4444
ruff
4545
basepython = python3.10
4646

47-
[testenv:docs]
48-
# Running sphinx from inside the "docs" directory
49-
# ensures it will not pick up any stray files that might
50-
# get into a virtual environment under the top-level directory
51-
# or other artifacts under build/
52-
changedir = docs
53-
# The only dependency is sphinx
54-
# If we were using extensions packaged separately,
55-
# we would specify them here.
56-
# A better practice is to specify a specific version of sphinx.
57-
deps =
58-
sphinx
59-
sphinx_rtd_theme
60-
# This is the sphinx command to generate HTML.
61-
# In other circumstances, we might want to generate a PDF or an ebook
62-
commands =
63-
sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
64-
# We use Python 3.8. Tox sometimes tries to autodetect it based on the name of
65-
# the testenv, but "docs" does not give useful clues so we have to be explicit.
66-
basepython = python3.8
67-
6847
[testenv]
6948
# Need to use develop install so that paths
7049
# for aggregate code coverage combine

0 commit comments

Comments
 (0)