Skip to content

Commit c1fdca0

Browse files
committed
Fix 'docs' tox environment and change warnings into errors
Also runs the 'docs' job on Travis to ensure documentation is building correctly.
1 parent a5137f2 commit c1fdca0

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

.travis.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ jobs:
1818
python: '3.5'
1919
- env: TOXENV=py36
2020
python: '3.6'
21+
- env: TOXENV=docs
22+
python: '3.6'
2123
- env: TOXENV=py37
2224
python: '3.7'
2325
sudo: required

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132
# Add any paths that contain custom static files (such as style sheets) here,
133133
# relative to this directory. They are copied after the builtin static files,
134134
# so a file named "default.css" will overwrite the builtin "default.css".
135-
html_static_path = ['_static']
135+
#html_static_path = ['_static']
136136

137137
# Add any extra paths that contain custom files (such as robots.txt or
138138
# .htaccess) here, relative to this directory. These files are copied

docs/features.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,20 +230,20 @@ provides an easy way to test content negotiation in your application:
230230
231231
232232
``accept_any`` - :mimetype:`*/*` accept header
233-
""""""""""""""""""""""""""""""""""""""""""""""
233+
``````````````````````````````````````````````
234234

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

237237

238238
``accept_json`` - :mimetype:`application/json` accept header
239-
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
239+
````````````````````````````````````````````````````````````
240240

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

244244

245245
``accept_jsonp`` - :mimetype:`application/json-p` accept header
246-
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
246+
```````````````````````````````````````````````````````````````
247247

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

tox.ini

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,8 @@ commands =
3131

3232
[testenv:docs]
3333
changedir = docs
34-
deps = -r../requirements/docs.txt
35-
34+
skipsdist = True
35+
usedevelop = True
36+
deps = -r requirements/docs.txt
3637
commands =
37-
make html
38-
39-
whitelist_externals =
40-
/usr/bin/make
38+
sphinx-build -W -b html . _build

0 commit comments

Comments
 (0)