Cleanup py27 support and docs
Make a few cleanups: - Remove obsolete sections from setup.cfg - Switch to using sphinx-build - Cleanup doc/source/conf.py to remove now obsolete content. - Use newer openstackdocstheme version - Remove install_command from tox.ini, the default is fine Change-Id: I3287169563c44d05cfab0329af9756f6de4f885c
This commit is contained in:
parent
0202da7162
commit
80c60a7bd6
@ -16,8 +16,6 @@ import subprocess
|
||||
import sys
|
||||
import os
|
||||
|
||||
import openstackdocstheme
|
||||
|
||||
# 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.
|
||||
@ -30,7 +28,7 @@ import openstackdocstheme
|
||||
|
||||
# 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',
|
||||
'sphinxcontrib.blockdiag',
|
||||
@ -120,9 +118,6 @@ html_theme = 'openstackdocs'
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
@ -139,12 +134,6 @@ html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
||||
# 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 = subprocess.check_output(git_cmd).decode('utf-8')
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
@ -189,8 +178,6 @@ html_use_index = False
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'Glance-Specsdoc'
|
||||
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
|
@ -1,8 +1,8 @@
|
||||
actdiag
|
||||
blockdiag
|
||||
nwdiag
|
||||
openstackdocstheme>=1.17.0 # Apache-2.0
|
||||
pbr>=1.8 # Apache-2.0
|
||||
openstackdocstheme>=1.32.0 # Apache-2.0
|
||||
pbr>=2.0 # Apache-2.0
|
||||
seqdiag
|
||||
sphinx>=1.6.2 # BSD
|
||||
sphinxcontrib-actdiag
|
||||
|
10
setup.cfg
10
setup.cfg
@ -10,13 +10,3 @@ classifier =
|
||||
Intended Audience :: Developers
|
||||
License :: OSI Approved :: Apache Software License
|
||||
Operating System :: POSIX :: Linux
|
||||
|
||||
[build_sphinx]
|
||||
builders = html
|
||||
all_files = 1
|
||||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
warning-is-error = 1
|
||||
|
||||
[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 = stestr run --slowest {posargs}
|
||||
|
||||
@ -20,5 +19,5 @@ whitelist_externals =
|
||||
rm
|
||||
commands =
|
||||
rm -rf doc/build
|
||||
python setup.py build_sphinx
|
||||
sphinx-build -W -b html doc/source doc/build/html
|
||||
whereto doc/source/_extra/.htaccess doc/test/redirect-tests.txt
|
||||
|
Loading…
Reference in New Issue
Block a user