Fix the docs run failing on Travis

Likely that the deprecation warning from cryptography is causing the
setup.py sphinx build command to return an error so the tox/travis job
is marked as failing. Changing to calling the sphinx-build command
directly solves this.

Also updated the sphinx config for built-in napoleon and faster builds
using jobs option.
This commit is contained in:
Calum Lind 2018-07-28 08:14:25 +01:00
parent e8e649a030
commit 3fc97672de
4 changed files with 10 additions and 9 deletions

View File

@ -1,6 +1,5 @@
twisted twisted
pyopenssl pyopenssl
sphinxcontrib-napoleon
pyxdg pyxdg
service_identity service_identity
pillow pillow

View File

@ -73,7 +73,12 @@ for mod_name in MOCK_MODULES:
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinxcontrib.napoleon', 'sphinx.ext.coverage'] extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.napoleon',
'sphinx.ext.coverage',
]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

View File

@ -1,7 +1,8 @@
[build_docs] [build_docs]
source-dir = docs/source source-dir = docs/source
build-dir = docs/build build-dir = docs/build
all_files = 1 all_files = true
fresh-env = true
[py2app] [py2app]
app = ['deluge/ui/ui_entry.py'] app = ['deluge/ui/ui_entry.py']

View File

@ -176,7 +176,6 @@ changedir = docs
deps = deps =
{[testenv]deps} {[testenv]deps}
sphinx sphinx
sphinxcontrib-napoleon
whitelist_externals = whitelist_externals =
{[testenv]whitelist_externals} {[testenv]whitelist_externals}
@ -185,11 +184,8 @@ sitepackages = {[docsbase]sitepackages}
deps = {[docsbase]deps} deps = {[docsbase]deps}
commands = commands =
python setup.py clean_docs python setup.py clean_docs
python -c "print '> sphinx-apidoc --force -o docs/source/modules/ deluge deluge/plugins\n'\ sphinx-apidoc --force -o docs/source/modules/ deluge deluge/plugins
'> sphinx-build -v -E -T -b html -d docs/build/doctrees docs/source docs/build/html';\ sphinx-build -v -j auto -E -T -b html -d docs/build/doctrees docs/source docs/build/html
import subprocess, sys; proc = subprocess.Popen(\
'python setup.py build_docs', shell=True, stderr=subprocess.PIPE);\
err = proc.communicate()[1]; print err; sys.exit(bool(err))"
[testenv:docscoverage] [testenv:docscoverage]
sitepackages = {[docsbase]sitepackages} sitepackages = {[docsbase]sitepackages}