diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..1cfea59 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,23 @@ +name: Validate docs + +on: + push: + paths: + - 'docs/**' + +jobs: + validate: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: "3.11" + + - name: Install build dependencies + run: pip install -r docs/requirements.txt + - name: Rendering HTML documentation + run: sphinx-build -b html docs/ html + - name: Inspect html rendered + run: cat html/index.html diff --git a/docs/installation.rst b/docs/installation.rst index 8f4d74c..f63e02c 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -18,7 +18,7 @@ The following HTTP libraries are supported: - ``boto3`` - ``http.client`` - ``httplib2`` -- ``requests`` (both 1.x and 2.x versions) +- ``requests`` (>=2.16.2 versions) - ``tornado.httpclient`` - ``urllib2`` - ``urllib3`` diff --git a/setup.py b/setup.py index 49d7ddc..0afb810 100644 --- a/setup.py +++ b/setup.py @@ -63,7 +63,7 @@ tests_require = [ "pytest", "pytest-aiohttp", "pytest-httpbin", - "requests", + "requests>=2.16.2", "tornado", # Needed to un-break httpbin 0.7.0. For httpbin >=0.7.1 and after, # this pin and the dependency itself can be removed, provided diff --git a/tox.ini b/tox.ini index 5df1b8b..51ad0a4 100644 --- a/tox.ini +++ b/tox.ini @@ -44,27 +44,6 @@ deps = ruff basepython = python3.10 -[testenv:docs] -# Running sphinx from inside the "docs" directory -# ensures it will not pick up any stray files that might -# get into a virtual environment under the top-level directory -# or other artifacts under build/ -changedir = docs -# The only dependency is sphinx -# If we were using extensions packaged separately, -# we would specify them here. -# A better practice is to specify a specific version of sphinx. -deps = - sphinx - sphinx_rtd_theme -# This is the sphinx command to generate HTML. -# In other circumstances, we might want to generate a PDF or an ebook -commands = - sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html -# We use Python 3.8. Tox sometimes tries to autodetect it based on the name of -# the testenv, but "docs" does not give useful clues so we have to be explicit. -basepython = python3.8 - [testenv] # Need to use develop install so that paths # for aggregate code coverage combine