test the docs

pitthsls · May 22, 2019 · 22fb783 · 22fb783
1 parent 6af04b0
commit 22fb783
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 8 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -38,14 +38,16 @@ jobs:
     env: TOXENV=manifest
   - python: 3.6
     env: TOXENV=lint
+  - python: 3.7
+    env: TOXENV=docs
 
 deploy:
   provider: pypi
   user: Wooble
   password:
     secure: hCCjmC5IU/Ch5Ux1WpOwnI5/veifCQ4uTs7z6HL7tQaaFkLArGlTSKuAGTs8P753PlxJwTiLvjYRkjHt0Tzav6GoZ3TkU4/QHnd6JZLhOth9uTj7ENgW3kWJ1zwZU9acLqDub1jqXglJVUWk6Ave1UMkNLFfhSnLW+v4x8m94Ww=
   on:
-    condition: "! $TOXENV =~ ^flake8|lint|manifest$"
+    condition: "! $TOXENV =~ ^flake8|lint|manifest|docs$"
     tags: true
     python: 3.6
   distributions: "sdist bdist_wheel"
diff --git a/docs/source/internal_apis.rst b/docs/source/internal_apis.rst
@@ -9,21 +9,21 @@ pycounter.sushi5 module
    :undoc-members:
 
 pycounter.constants module
------------------------
+--------------------------
 
 .. automodule:: pycounter.constants
    :members:
    :undoc-members:
 
 pycounter.csvhelper module
------------------------
+--------------------------
 
 .. automodule:: pycounter.csvhelper
    :members:
    :undoc-members:
 
 pycounter.helpers module
------------------------
+------------------------
 
 .. automodule:: pycounter.helpers
    :members:

diff --git a/pycounter/sushi5.py b/pycounter/sushi5.py
@@ -127,7 +127,7 @@ def get_sushi_stats_raw(
     """Get SUSHI stats for a given site in dict (decoded from JSON) format.
 
     :param wsdl_url: (Deprecated; for backward compatibility with COUNTER 4 SUSHI
-    code. Use `url` instead.) URL to API endpoint for this provider
+        code. Use `url` instead.) URL to API endpoint for this provider
 
     :param start_date: start date for report (must be first day of a month)
 

diff --git a/setup.py b/setup.py
@@ -39,7 +39,6 @@
     description="Project COUNTER/NISO SUSHI statistics",
     long_description=readme,
     keywords="library COUNTER journals usage_statistics SUSHI",
-    test_suite="pycounter.test",
     classifiers=[
         "Development Status :: 3 - Alpha",
         "License :: OSI Approved :: MIT License",
@@ -50,7 +49,10 @@
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
     ],
+    extras_require={
+        "docs": ["sphinx", "sphinx_rtd_theme"],
+        "tests": ["httmock", "mock", "pytest"],
+    },
     install_requires=requirements,
-    tests_require=["httmock", "mock", "pytest"],
     entry_points={"console_scripts": ["sushiclient = pycounter.sushiclient:main"]},
 )
diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py34,py35,py36,py37,pypy,pypy3,flake8,manifest,lint
+envlist = py27,py34,py35,py36,py37,pypy,pypy3,flake8,manifest,lint,docs
 
 [testenv]
 deps=
@@ -40,3 +40,10 @@ deps=
         check-manifest
 commands=
         check-manifest
+
+[testenv:docs]
+basepython=python3.7
+extras = docs
+commands =
+  sphinx-build -W -b html docs/source docs/build/html
+  sphinx-build -W -b doctest docs/source docs/build/html