Use "modern" way of building docs
We don't use python build_sphinx anymore, replace with sphinx-build according to PTI. Remove related configuration from setup.cfg. This repo builds only docs, so no need for a separate doc/requirements.txt file, remove its usage. Cleanup requirements files, we need only requirements for building docs. Update conf.py for newer openstackdocstheme. Change-Id: I3f37375b77aaf2f652a69d396a2bc22fb7a7ee40
This commit is contained in:
parent
130aa09fdb
commit
aacc95087f
|
@ -56,9 +56,9 @@ bug_tracker_url = u'https://launchpad.net/tripleo'
|
||||||
# built documents.
|
# built documents.
|
||||||
#
|
#
|
||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = '3.0.0'
|
# version = '3.0.0'
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = '3.0.0'
|
# release = '3.0.0'
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
@ -111,18 +111,6 @@ html_theme = 'openstackdocs'
|
||||||
|
|
||||||
# -- Options for LaTeX output ------------------------------------------------
|
# -- Options for LaTeX output ------------------------------------------------
|
||||||
|
|
||||||
latex_elements = {
|
|
||||||
# The paper size ('letterpaper' or 'a4paper').
|
|
||||||
# 'papersize': 'letterpaper',
|
|
||||||
|
|
||||||
# The font size ('10pt', '11pt' or '12pt').
|
|
||||||
# 'pointsize': '10pt',
|
|
||||||
|
|
||||||
# Additional stuff for the LaTeX preamble.
|
|
||||||
# 'preamble': '',
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def _get_name_version(index=1):
|
def _get_name_version(index=1):
|
||||||
response = requests.get('https://releases.openstack.org/')
|
response = requests.get('https://releases.openstack.org/')
|
||||||
release_list = PyQuery(response.content)
|
release_list = PyQuery(response.content)
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
# The order of packages is significant, because pip processes them in the order
|
# 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
|
# of appearance. Changing the order has an impact on the overall integration
|
||||||
# process, which may cause wedges in the gate later.
|
# process, which may cause wedges in the gate later.
|
||||||
openstackdocstheme>=1.5.0 # Apache-2.0
|
|
||||||
|
openstackdocstheme>=1.20.0 # Apache-2.0
|
||||||
|
|
|
@ -18,12 +18,6 @@ classifier =
|
||||||
Programming Language :: Python :: 3
|
Programming Language :: Python :: 3
|
||||||
Programming Language :: Python :: 3.3
|
Programming Language :: Python :: 3.3
|
||||||
|
|
||||||
[build_sphinx]
|
|
||||||
all_files = 1
|
|
||||||
build-dir = doc/build
|
|
||||||
source-dir = doc/source
|
|
||||||
warning-is-error = 1
|
|
||||||
|
|
||||||
[egg_info]
|
[egg_info]
|
||||||
tag_build =
|
tag_build =
|
||||||
tag_date = 0
|
tag_date = 0
|
||||||
|
|
|
@ -4,16 +4,7 @@
|
||||||
# Doc requirements
|
# Doc requirements
|
||||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
|
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
|
||||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
|
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
|
||||||
sphinx_rtd_theme==0.1.7
|
|
||||||
sphinxcontrib-mermaid
|
sphinxcontrib-mermaid
|
||||||
|
|
||||||
hacking<1.2.0,>=1.1.0
|
requests
|
||||||
|
pyquery
|
||||||
fixtures>=3.0.0 # Apache-2.0/BSD
|
|
||||||
python-subunit>=0.0.18 # Apache-2.0/BSD
|
|
||||||
testrepository>=0.0.18 # Apache-2.0/BSD
|
|
||||||
testscenarios>=0.4 # Apache-2.0/BSD
|
|
||||||
testtools>=1.4.0 # MIT
|
|
||||||
mock>=2.0 # BSD
|
|
||||||
oslotest>=1.10.0 # Apache-2.0
|
|
||||||
bashate>=0.2 # Apache-2.0
|
|
||||||
|
|
3
tox.ini
3
tox.ini
|
@ -17,8 +17,7 @@ commands = {posargs}
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
commands =
|
commands =
|
||||||
pip install -r {toxinidir}/doc/requirements.txt
|
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
|
||||||
python setup.py build_sphinx
|
|
||||||
|
|
||||||
[testenv:pep8]
|
[testenv:pep8]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
|
|
Loading…
Reference in New Issue