Update docs building

The repo used both openstackdocstheme and oslosphinx in requirements but
then configured openstackdocstheme, remove oslosphinx everywhere.

Instead of using sphinx-build, use  docstheme-build-translated.sh to
build English and translated documents.

Update doc/source/conf.py for newer openstackdocstheme and require
a new enough version.

Remove module index - it does not exist, this is not a python repo where
autodoc works.

Remove sphinx-quickstart generated output from index.rst, it's not
needed anymore.

Change-Id: Ib3f09128226f0bcc78384b1ee2da811d62a5b59d
This commit is contained in:
Andreas Jaeger 2018-12-12 20:32:44 +01:00 committed by Tin Lam
parent 7d90483eda
commit 1d5dfa2468
4 changed files with 4 additions and 12 deletions

View File

@ -3,5 +3,4 @@
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
sphinx>=1.6.2 # BSD sphinx>=1.6.2 # BSD
sphinxcontrib-blockdiag>=1.1.0 sphinxcontrib-blockdiag>=1.1.0
oslosphinx>=4.7.0 # Apache-2.0 openstackdocstheme>=1.28.0 # Apache-2.0
openstackdocstheme>=1.17.0 # Apache-2.0

View File

@ -20,9 +20,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.autodoc',
'openstackdocstheme', 'openstackdocstheme',
'oslosphinx',
'sphinxcontrib.blockdiag' 'sphinxcontrib.blockdiag'
] ]
@ -30,6 +28,7 @@ extensions = [
repository_name = 'openstack/openstack-helm' repository_name = 'openstack/openstack-helm'
bug_project = '886' bug_project = '886'
bug_tag = 'docs' bug_tag = 'docs'
use_storyboard = True
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles. # text edit cycles.
@ -72,7 +71,7 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y' # html_last_updated_fmt = '%b %d, %Y'
html_last_updated_fmt = '%Y-%m-%d %H:%M' # html_last_updated_fmt = '%Y-%m-%d %H:%M'
# The theme to use for HTML and HTML Help pages. Major themes that come with # The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'. # Sphinx are currently 'default' and 'sphinxdoc'.

View File

@ -1,8 +1,3 @@
.. openstack-helm documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to OpenStack-Helm's documentation! Welcome to OpenStack-Helm's documentation!
========================================== ==========================================
@ -24,5 +19,4 @@ Indices and Tables
================== ==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex`
* :ref:`search` * :ref:`search`

View File

@ -18,6 +18,6 @@ basepython = python3
deps = -r{toxinidir}/doc/requirements.txt deps = -r{toxinidir}/doc/requirements.txt
commands = commands =
bash -c "rm -rf doc/build" bash -c "rm -rf doc/build"
python setup.py build_sphinx docstheme-build-translated.sh
whitelist_externals = whitelist_externals =
bash bash