Remove usage of oslosphinx

Seems like some recent update of Sphinx broke oslosphinx extension. We
don't really need it now, so this commit removes it by adopting the
"modern" way of building docs (mostly based on how it's done in
openstack/kuryr-kubernetes).

Change-Id: I8a0d5e3923b6497eb7c6944fc6d9adc9007bf5ec
Closes-Bug: 1824958
This commit is contained in:
Michał Dulko 2019-04-16 09:54:47 +02:00
parent 0d51e9905b
commit 8b5dd76a46
4 changed files with 17 additions and 8 deletions

6
doc/requirements.txt Normal file
View File

@ -0,0 +1,6 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0

View File

@ -22,8 +22,8 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'oslosphinx',
'sphinx.ext.todo',
'openstackdocstheme',
'reno.sphinxext'
]
@ -41,6 +41,12 @@ master_doc = 'index'
project = u'kuryr'
copyright = u'2017, OpenStack Foundation'
# openstackdocstheme options
repository_name = 'openstack/kuryr-tempest-plugin'
bug_project = 'kuryr-kubernetes'
bug_tag = ''
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -56,7 +62,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
html_theme = 'openstackdocs'
# html_static_path = ['static']
# Output file base name for HTML help builder.

View File

@ -6,9 +6,5 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
bashate>=0.5.1 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0
mock>=2.0.0 # BSD
oslosphinx>=4.7.0 # Apache-2.0
pylint==1.4.5 # GNU GPL v2
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD

View File

@ -21,7 +21,8 @@ passenv = OS_*
[testenv:docs]
basepython = python3
commands = python setup.py build_sphinx
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html doc/source doc/build/html
[testenv:pep8]
basepython = python3