Skip to content
This repository was archived by the owner on Apr 22, 2024. It is now read-only.

Commit 0d04c73

Browse files
committed
Fix sphinx builds
Change the files requirements-{docs,dev}.txt to fix sphinx builds. Change the file docs/conf.py to fix sphinx build. Add the flag -W at Makefile to break if appear some warning in sphinx builds.
1 parent e994b22 commit 0d04c73

5 files changed

Lines changed: 13 additions & 11 deletions

File tree

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS =
5+
SPHINXOPTS = -W
66
SPHINXBUILD = sphinx-build
77
PAPER =
88
BUILDDIR = _build

docs/conf.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -377,10 +377,8 @@
377377
# Note: links to Python doc only work if you are online or have python.inv
378378
# file. To download it, run:
379379
# curl https://docs.python.org/3/objects.inv >python.inv
380-
intersphinx_mapping = {'python': ('https://docs.python.org/3',
381-
(None, 'python.inv')),
382-
'kytos': ('http://docs.kytos.io/kytos',
383-
(None, 'kytos.inv'))}
380+
intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
381+
'kytos': ('http://docs.kytos.io/kytos', None)}
384382

385383
# Napoleon settings from http://www.sphinx-doc.org/en/stable/ext/napoleon.html
386384
napoleon_google_docstring = True

requirements-dev.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
tox ~= 2.7
33

44
# For running doctests (during "python setup.py test")
5-
Sphinx >= 1.4.5
6-
sphinx_bootstrap_theme
5+
Sphinx == 1.5.6
6+
sphinx_bootstrap_theme == 0.4.14
77

88
# Linters
99
pydocstyle ~= 1.1

requirements-docs.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# are required:
33

44
# Sphinx is required for running doctests (and building documentation)
5-
Sphinx >= 1.4.5
5+
Sphinx == 1.5.6
66
# To run "make livehtml", build docs and refresh browser automatically when
77
# files change
88
sphinx-autobuild >= 0.6.0
99
sphinx-rtd-theme >= 0.1.9
10-
sphinx_bootstrap_theme
10+
sphinx_bootstrap_theme == 0.4.14

tox.ini

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22
envlist = py36
33

44
[testenv]
5-
whitelist_externals = rm
5+
whitelist_externals=
6+
rm
7+
make
8+
69
commands=
710
; Force packaging even if setup.{py,cfg} haven't changed
811
rm -rf ./python_openflow.egg-info/
912
coverage run setup.py test
10-
sphinx-build -b doctest -d docs/_build/doctrees docs/ docs/_build/doctest
13+
make -C docs/
14+
make -C docs/ doctest
1115
pylama tests setup.py pyof
1216

1317
deps=

0 commit comments

Comments
 (0)