openstack/openstack-helm
Code Issues Proposed changes
8bf8282f6d
openstack-helm/doc/source/index.rst

28 lines
551 B
ReStructuredText
Raw Normal View History

Beggining of docs conversion to OpenStack format 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
2017-04-27 11:01:26 +02:00
.. 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!
========================================================
Contents:
.. toctree::
:maxdepth: 3
readme
Convert guides-welcome 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
2017-04-27 12:48:35 +02:00
philosophy
Convert guides-install 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
2017-04-27 15:06:02 +02:00
install/index
Convert guides-developer 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
2017-04-27 15:31:00 +02:00
devref/index
Convert guides-operations to RST 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
2017-04-27 17:00:59 +02:00
operator/index
Beggining of docs conversion to OpenStack format 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
2017-04-27 11:01:26 +02:00
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Copy Permalink