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
Current setting the maxdepth of 3 causes all the sub-headings
(e.g. sub-titles under specs) to be displayed, needless expanding
the table of content making the doc hard to read. This patch set
reduces the maxdepth to 2 to reduce the noise in the OpenStack-Helm
documentation.
Also, this patch set touches up on RST structure and capitalization
changes in the document.
Change-Id: I7b8845f42180eafe08ed68a6c5a1e82ea49927be
Signed-off-by: Tin Lam <tin@irrational.io>
Adds the specs/ directory to openstack-helm for housing future
specifications for the project. It also includes an appropriate
README with directions for drafting specs, links to the openstack
resources for bp+spec lifecycle, and a template for use in
drafting specifications
Change-Id: Ice23447b358b520a8b4fb703fc836e8f09fa34d1
Adds basic expectations and explanations of openstack-helms
testing and gating approaches. This will continue to be expanded
upon but serves to provide a base on which to build
Change-Id: I689446b7124c4e11a92c73ef04e95d1840c6dc0a
This removes empty documentation pages and places the
troubleshooting docs to the top of the docs/source tree. Also
places the pod disruption budget docs to the rest of the
getting-started docs, which are primarily concepts used in
openstack-helm
Change-Id: Ic3f8deefbd873ae5332e14a12351d9967eb22b1b
Removes the current philosophy docs for openstack-helm. As the
repo continues to change, we should consider approaching the
philosophy for openstack-helm in a different manner.
Change-Id: I284baa6e50229f020d201875c48e8f27dc5663ca
This commit compiles guides-operations pages into multiple .rst files and
adds them to rst docs index.
Change-Id: I14b75a513499374b8d274364da616d47bda2018e
Partial-Implements: blueprint docs-to-rst
This commit compiles guides-developer pages into multiple .rst files and
adds them to rst docs index.
Change-Id: I6b62473f67482c9c17d7fda1ec7bbc4072b66aa8
Partial-Implements: blueprint docs-to-rst
This commit compiles guides-install pages into multiple .rst files and
adds them to rst docs index.
Change-Id: Iae68f29c2a2d7252336d798281b8ed8657af6deb
Partial-Implements: blueprint docs-to-rst
This commit compiles guides-welcome pages into single philosophy.rst
page. I've decided to name the section "Philosophy", as that's the only
distinctive content that was in original guides-welcome/*.md files.
Partial-Implements: blueprint docs-to-rst
Change-Id: I7ab5d6465008fc4be2a8c28dd8ca8abbfde0df25
This commit introduces initial infrastructure for building documentation
using the OpenStack's sphinx extension and tox. To demonstrate that
README.md is rewritten into README.rst and should appear in
documentation built by `tox -e docs`.
Partial-Implements: blueprint docs-to-rst
Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
