Merge pull request #459 from requests/tox-docs

Fix Docs generation - Improve Pipeline

Author: JonathanHuot

.readthedocs.yaml

@@ -0,0 +1,18 @@
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.7"
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  # fail_on_warning: true
+# the requirements.txt override some RTD defaults.
+# ideally it has to be updated from time to time
+# with latest libraries versions.
+python:
+   install:
+   - requirements: docs/requirements.txt
+   - method: setuptools
+     path: .

.travis.yml

@@ -1,28 +1,30 @@
-dist: xenial
+dist: bionic
 sudo: false
 language: python
 cache: pip
-python:
-  - 2.7
-  - 3.4
-  - 3.5
-  - 3.6
-  - 3.7
-  - pypy2.7-6.0
-  - pypy3.5-6.0
-install:
-  - pip install -r requirements.txt
-  - pip install requests-mock
-  - pip install coveralls
-script:
-  - coverage run --source=requests_oauthlib -m unittest discover
-after_success:
-  - coveralls
-
 matrix:
   include:
-  - name: "Black"
-    python: 3.7
-    install: travis_retry pip install black
-    script: black --check .
+  - python: 2.7
+    env: TOXENV=py27
+  - python: 3.4
+    env: TOXENV=py34
+  - python: 3.5
+    env: TOXENV=py35
+  - python: 3.6
+    env: TOXENV=py36
+  - python: 3.7
+    env: TOXENV=py37,docs,readme
+  - python: 3.7
+    env: TOXENV=black
     after_success: skip
+  - python: pypy2.7-6.0
+    env: TOXENV=pypy
+  - python: pypy3.5-6.0
+    env: TOXENV=pypy3
+before_install:
+  - python -m pip install --upgrade pip setuptools
+  - python -m pip install tox coveralls
+  script:
+  - tox
+after_success:
+  - COVERALLS_PARALLEL=true coveralls

docs/conf.py

@@ -124,7 +124,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx<2
+docutils<=0.15  # docutils 0.16 has an error when generating in api.rst
+sphinx_rtd_theme<0.5
+readthedocs-sphinx-ext

requirements-test.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+coveralls==3.2.0
+mock==4.0.3
+requests-mock==1.9.3

requirements.in

@@ -0,0 +1,2 @@
+requests>=2.0.0
+oauthlib[signedtoken]>=3.0.0

requirements.txt

@@ -1,2 +1,2 @@
-requests>=2.0.0
-oauthlib[signedtoken]>=3.0.0
+requests==2.26.0
+oauthlib[signedtoken]==3.1.1

setup.py

@@ -38,6 +38,7 @@ def readall(path):
     version=VERSION,
     description="OAuthlib authentication support for Requests.",
     long_description=readall("README.rst") + "\n\n" + readall("HISTORY.rst"),
+    long_description_content_type="text/x-rst",
     author="Kenneth Reitz",
     author_email="[email protected]",
     url="https://github.com/requests/requests-oauthlib",

tox.ini

@@ -1,10 +1,30 @@
 [tox]
-envlist = py27, py34, py35, py36, py37, pypy, pypy3
+envlist=py27,py34,py35,py36,py37,pypy,pypy3,docs,readme,black
 
 [testenv]
 deps=
-    -r{toxinidir}/requirements.txt
-    mock
-    coveralls
-    requests-mock
-commands= coverage run --source=requests_oauthlib -m unittest discover
+    -r{toxinidir}/requirements-test.txt
+commands=coverage run --source=requests_oauthlib -m unittest discover
+
+# tox -e docs to mimick readthedocs build.
+# should be similar to .readthedocs.yaml pipeline
+[testenv:docs]
+basepython=python3.7
+skipsdist=True
+deps=
+    -r{toxinidir}/docs/requirements.txt
+changedir=docs
+whitelist_externals=make
+commands=make clean html
+
+# tox -e readme to mimick pypi validation of readme/rst files.
+[testenv:readme]
+basepython=python3.7
+deps=twine>=1.12.0
+commands=
+        twine check .tox/dist/*
+
+[testenv:black]
+basepython=python3.7
+deps=black
+commands=black --check .