Skip to content

Commit

Permalink
Fix 'docs' tox environment and change warnings into errors
Browse files Browse the repository at this point in the history
Also runs the 'docs' job on Travis to ensure documentation is building
correctly.
  • Loading branch information
nicoddemus committed Sep 29, 2018
1 parent a5137f2 commit c1fdca0
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ jobs:
python: '3.5'
- env: TOXENV=py36
python: '3.6'
- env: TOXENV=docs
python: '3.6'
- env: TOXENV=py37
python: '3.7'
sudo: required
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,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']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
Expand Down
6 changes: 3 additions & 3 deletions docs/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -230,20 +230,20 @@ provides an easy way to test content negotiation in your application:
``accept_any`` - :mimetype:`*/*` accept header
""""""""""""""""""""""""""""""""""""""""""""""
``````````````````````````````````````````````

:mimetype:`*/*` accept header suitable to use as parameter in ``client``.


``accept_json`` - :mimetype:`application/json` accept header
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
````````````````````````````````````````````````````````````

:mimetype:`application/json` accept header suitable to use as parameter in
``client``.


``accept_jsonp`` - :mimetype:`application/json-p` accept header
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
```````````````````````````````````````````````````````````````

:mimetype:`application/json-p` accept header suitable to use as parameter in
``client``.
Expand Down
10 changes: 4 additions & 6 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,8 @@ commands =

[testenv:docs]
changedir = docs
deps = -r../requirements/docs.txt

skipsdist = True
usedevelop = True
deps = -r requirements/docs.txt
commands =
make html

whitelist_externals =
/usr/bin/make
sphinx-build -W -b html . _build

0 comments on commit c1fdca0

Please sign in to comment.