Cleanup py27 support and docs
Make a few cleanups: - Remove obsolete sections from setup.cfg - Switch to using sphinx-build; fix warnings found: convert unreferenced footnote into normal link - Cleanup doc/source/conf.py to remove now obsolete content. - Use newer openstackdocstheme version, update some other versions as needed - Remove install_command from tox.ini, the default is fine; cleanup for python3 only Change-Id: If18af73f3886ad32622801193f7f7ae53458b50c
This commit is contained in:
parent
ae1d6a4aef
commit
4472d399c1
|
@ -1,8 +1,6 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
import datetime
|
||||
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
|
||||
|
@ -100,11 +98,6 @@ html_theme = 'openstackdocs'
|
|||
# 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 @@
|
|||
openstackdocstheme>=1.19.0 # Apache-2.0
|
||||
pbr>=0.6
|
||||
sphinx>=1.1.2
|
||||
openstackdocstheme>=1.32.1 # Apache-2.0
|
||||
pbr>=2.0
|
||||
sphinx>=1.8.1
|
||||
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
|
||||
|
|
|
@ -191,11 +191,11 @@ References
|
|||
.. [IPMI] `IPMI tool source code
|
||||
<http://ipmitool.sourceforge.net/>`_
|
||||
|
||||
.. [IRONIC_INSTALLATION_GUIDE] `Bare Metal Service Installation Guide
|
||||
<https://docs.openstack.org/developer/ironic/deploy/install-guide.html>`_
|
||||
|
||||
.. [PXE] `PXE user guide
|
||||
<https://docs.openstack.org/developer/ironic/deploy/user-guide.html#pxe>`_
|
||||
|
||||
.. [REST_API_V1] `Bare Metal RESTful Web API v1
|
||||
<https://docs.openstack.org/developer/ironic/webapi/v1.html>`_
|
||||
|
||||
`Bare Metal Service Installation Guide
|
||||
<https://docs.openstack.org/developer/ironic/deploy/install-guide.html>`_
|
||||
|
|
7
tox.ini
7
tox.ini
|
@ -2,16 +2,15 @@
|
|||
envlist = docs
|
||||
|
||||
[testenv]
|
||||
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}'
|
||||
|
||||
[testenv:venv]
|
||||
basepython = python3
|
||||
commands = {posargs}
|
||||
|
||||
[testenv:docs]
|
||||
basepython = python3
|
||||
commands = python setup.py build_sphinx
|
||||
commands =
|
||||
sphinx-build -W -b html doc/source doc/build/html
|
||||
|
|
Loading…
Reference in New Issue