Browse Source

Update docs building

Switch to newer sphinx, update build instructions for it.

Remove oslosphinx, we use the default sphinx theme since oslosphinx does
not work with python3 and openstackdocstheme is only for OpenStack
projects.

Mark python 3.6 as latest python version.

Change-Id: I6aae0277d9e4943cc242e4ec868c949a14618ec7
changes/51/662251/1
Andreas Jaeger 2 years ago
parent
commit
21b755c2dc
  1. 1
      doc/source/conf.py
  2. 1
      requirements.txt
  3. 2
      setup.cfg
  4. 2
      test-requirements.txt
  5. 6
      tox.ini

1
doc/source/conf.py

@ -22,7 +22,6 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'oslosphinx'
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy

1
requirements.txt

@ -5,5 +5,4 @@
jinja2
pbr>=1.6
six>=1.9.0
oslosphinx
simplejson>=2.2.0

2
setup.cfg

@ -16,7 +16,7 @@ classifier =
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.3
Programming Language :: Python :: 3.6
[global]
setup-hooks =

2
test-requirements.txt

@ -7,7 +7,7 @@ coverage>=3.6
doc8
fixtures>=1.3.1
python-subunit
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
sphinx>=1.6.2
testrepository>=0.0.18
testscenarios>=0.4
testtools>=1.4.0

6
tox.ini

@ -1,6 +1,6 @@
[tox]
minversion = 1.6
envlist = py35,py27,pypy,pep8,checksyntax,dashboards
envlist = py36,py27,pypy,pep8,checksyntax,dashboards
skipsdist = True
[testenv]
@ -33,7 +33,7 @@ basepython = python3
commands =
# not happy with generated dashboard pages
# doc8 -e .rst doc CONTRIBUTING.rst HACKING.rst README.rst
python setup.py build_sphinx
sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
[flake8]
# H803 skipped on purpose per list discussion.
@ -48,7 +48,7 @@ exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build
basepython = python3
commands =
bash -c "tools/generate_dashboards.sh"
sphinx-build doc/source/ build/
sphinx-build -b html doc/source/ doc/build/html
[testenv:bindep]
basepython = python3

Loading…
Cancel
Save