Cleanup py27 support
Make a few cleanups: - Remove obsolete sections from setup.cfg - Switch to using sphinx-build - Switch to openstackdocstheme, update requirements for this - Cleanup doc/source/conf.py to remove now obsolete content. - Remove install_command from tox.ini, the default is fine Change-Id: If26e126d88b33cd45a72932d1b271f7f08d50652
This commit is contained in:
parent
5edab697f6
commit
71013aed21
@ -9,9 +9,6 @@
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
@ -24,10 +21,10 @@ import os
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc',
|
||||
extensions = [
|
||||
'sphinx.ext.todo',
|
||||
'sphinx.ext.viewcode',
|
||||
'oslosphinx'
|
||||
'openstackdocstheme'
|
||||
]
|
||||
|
||||
todo_include_todos = True
|
||||
@ -82,6 +79,11 @@ pygments_style = 'sphinx'
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
modindex_common_prefix = ['solum-specs.']
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/solum-specs'
|
||||
bug_project = 'solum'
|
||||
bug_tag = 'specs'
|
||||
|
||||
# -- Options for man page output ----------------------------------------------
|
||||
man_pages = []
|
||||
|
||||
@ -89,7 +91,9 @@ man_pages = []
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'nature'
|
||||
html_theme = 'openstackdocs'
|
||||
|
||||
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
@ -115,11 +119,6 @@ html_theme = 'nature'
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
|
||||
html_last_updated_fmt = os.popen(git_cmd).read()
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
@ -1,5 +1,5 @@
|
||||
oslosphinx
|
||||
pbr>=0.6,!=0.7,<1.0
|
||||
sphinx>=1.1.2,!=1.2.0,<1.3
|
||||
pbr>=2.0,!=2.1
|
||||
sphinx>=2.0.0
|
||||
openstackdocstheme>=2.0.0
|
||||
testrepository>=0.0.18
|
||||
testtools>=0.9.34
|
||||
|
11
setup.cfg
11
setup.cfg
@ -10,14 +10,3 @@ classifier =
|
||||
Intended Audience :: Developers
|
||||
License :: OSI Approved :: Apache Software License
|
||||
Operating System :: POSIX :: Linux
|
||||
|
||||
[build_sphinx]
|
||||
all_files = 1
|
||||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
|
||||
[pbr]
|
||||
warnerrors = True
|
||||
|
||||
[wheel]
|
||||
universal = 1
|
||||
|
3
tox.ini
3
tox.ini
@ -8,7 +8,6 @@ ignore_basepython_conflict = True
|
||||
basepython = python3
|
||||
usedevelop = True
|
||||
setenv = VIRTUAL_ENV={envdir}
|
||||
install_command = pip install -U {opts} {packages}
|
||||
deps = -r{toxinidir}/requirements.txt
|
||||
commands = python setup.py testr --slowest --testr-args='{posargs}'
|
||||
|
||||
@ -16,4 +15,4 @@ commands = python setup.py testr --slowest --testr-args='{posargs}'
|
||||
commands = {posargs}
|
||||
|
||||
[testenv:docs]
|
||||
commands = python setup.py build_sphinx
|
||||
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||
|
Loading…
x
Reference in New Issue
Block a user