Update docs structure
The upstream docs structure is changing, so this change updates our existing docs into contributor and install guide sections. Change-Id: I37fabd25fdda6bc56fcfb331b74e3294e31e68bb
|
@ -10,7 +10,6 @@
|
||||||
# serve to show the default.
|
# serve to show the default.
|
||||||
|
|
||||||
import sys, os
|
import sys, os
|
||||||
import sphinx_rtd_theme
|
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# 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
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
@ -27,7 +26,7 @@ import sphinx_rtd_theme
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
'sphinx.ext.intersphinx',
|
'sphinx.ext.intersphinx',
|
||||||
'oslosphinx'
|
'openstackdocstheme'
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@ -99,6 +98,9 @@ templates_path = ['../../_templates']
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = '%sdoc' % project
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------------
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
|
|
||||||
|
@ -118,3 +120,8 @@ rst_prolog = """
|
||||||
.. |bug_tracker| replace:: %s
|
.. |bug_tracker| replace:: %s
|
||||||
.. |bug_tracker_url| replace:: %s
|
.. |bug_tracker_url| replace:: %s
|
||||||
""" % (project, bug_tracker, bug_tracker_url)
|
""" % (project, bug_tracker, bug_tracker_url)
|
||||||
|
|
||||||
|
# openstackdocstheme options
|
||||||
|
repository_name = 'openstack/tripleo-docs'
|
||||||
|
bug_project = 'tripleo'
|
||||||
|
bug_tag = 'documentation'
|
||||||
|
|
|
@ -10,7 +10,6 @@
|
||||||
# serve to show the default.
|
# serve to show the default.
|
||||||
|
|
||||||
import sys, os
|
import sys, os
|
||||||
import openstackdocstheme
|
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# 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
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
@ -27,7 +26,7 @@ import openstackdocstheme
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
'sphinx.ext.intersphinx',
|
'sphinx.ext.intersphinx',
|
||||||
'oslosphinx'
|
'openstackdocstheme'
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@ -103,9 +102,6 @@ htmlhelp_basename = '%sdoc' % project
|
||||||
# a list of builtin themes.
|
# a list of builtin themes.
|
||||||
html_theme = 'openstackdocs'
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
|
||||||
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------------
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
|
|
||||||
latex_elements = {
|
latex_elements = {
|
||||||
|
@ -124,3 +120,8 @@ rst_prolog = """
|
||||||
.. |bug_tracker| replace:: %s
|
.. |bug_tracker| replace:: %s
|
||||||
.. |bug_tracker_url| replace:: %s
|
.. |bug_tracker_url| replace:: %s
|
||||||
""" % (project, bug_tracker, bug_tracker_url)
|
""" % (project, bug_tracker, bug_tracker_url)
|
||||||
|
|
||||||
|
# openstackdocstheme options
|
||||||
|
repository_name = 'openstack/tripleo-docs'
|
||||||
|
bug_project = 'tripleo'
|
||||||
|
bug_tag = 'documentation'
|
||||||
|
|
|
@ -13,7 +13,7 @@ development is happening in OpenStack upstream.
|
||||||
Learn `how to contribute into OpenStack's upstream <https://wiki.openstack.org/
|
Learn `how to contribute into OpenStack's upstream <https://wiki.openstack.org/
|
||||||
wiki/How_To_Contribute>`_.
|
wiki/How_To_Contribute>`_.
|
||||||
|
|
||||||
See :doc:`../introduction/components` to find out how to contribute into
|
See :doc:`../install/introduction/components` to find out how to contribute into
|
||||||
individual projects.
|
individual projects.
|
||||||
|
|
||||||
Contributing to this Documentation
|
Contributing to this Documentation
|
||||||
|
@ -37,7 +37,7 @@ upstream projects, please follow OpenStack's process of filing bugs.
|
||||||
<https://wiki.openstack.org/wiki/Bugs>`_.
|
<https://wiki.openstack.org/wiki/Bugs>`_.
|
||||||
|
|
||||||
* If you want to file a bug against upstream project, you can find useful links
|
* If you want to file a bug against upstream project, you can find useful links
|
||||||
in our list of :doc:`../introduction/components`.
|
in our list of :doc:`../install/introduction/components`.
|
||||||
|
|
||||||
|
|
||||||
**TripleO** If the bug impacts the |project| project as a whole, you can file a
|
**TripleO** If the bug impacts the |project| project as a whole, you can file a
|
||||||
|
@ -59,4 +59,4 @@ all the features are being requested upstream via Blueprints.
|
||||||
<https://wiki.openstack.org/wiki/Blueprints>`_.
|
<https://wiki.openstack.org/wiki/Blueprints>`_.
|
||||||
|
|
||||||
* If you want to file a bug against upstream project, you can find useful links
|
* If you want to file a bug against upstream project, you can find useful links
|
||||||
in our list of :doc:`../introduction/components`.
|
in our list of :doc:`../install/introduction/components`.
|
|
@ -0,0 +1,8 @@
|
||||||
|
TripleO Contributor Guide
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:includehidden:
|
||||||
|
|
||||||
|
contributions
|
|
@ -6,27 +6,24 @@ clouds using OpenStack's own cloud facilities as the foundation - building on
|
||||||
Nova, Ironic, Neutron and Heat to automate cloud management at datacenter
|
Nova, Ironic, Neutron and Heat to automate cloud management at datacenter
|
||||||
scale.
|
scale.
|
||||||
|
|
||||||
Contents:
|
|
||||||
|
Contribute Guide
|
||||||
|
----------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 3
|
||||||
|
:includehidden:
|
||||||
|
|
||||||
introduction/introduction
|
contributor/index
|
||||||
environments/environments
|
|
||||||
installation/installation
|
|
||||||
basic_deployment/basic_deployment_cli
|
|
||||||
containers_deployment/index
|
|
||||||
post_deployment/post_deployment
|
|
||||||
advanced_deployment/features
|
|
||||||
advanced_deployment/baremetal_nodes
|
|
||||||
advanced_deployment/backends
|
|
||||||
advanced_deployment/custom
|
|
||||||
troubleshooting/troubleshooting
|
|
||||||
validations/validations
|
|
||||||
mistral-api/mistral-api
|
|
||||||
developer/developer
|
|
||||||
contributions/contributions
|
|
||||||
|
|
||||||
|
Install Guide
|
||||||
|
-------------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
:includehidden:
|
||||||
|
|
||||||
|
install/index
|
||||||
|
|
||||||
Documentation Conventions
|
Documentation Conventions
|
||||||
=========================
|
=========================
|
||||||
|
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 92 KiB |
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 120 KiB After Width: | Height: | Size: 120 KiB |
Before Width: | Height: | Size: 259 KiB After Width: | Height: | Size: 259 KiB |
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.0 KiB |
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 138 KiB |
Before Width: | Height: | Size: 243 KiB After Width: | Height: | Size: 243 KiB |
|
@ -0,0 +1,21 @@
|
||||||
|
TripleO Install Guide
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:includehidden:
|
||||||
|
|
||||||
|
introduction/introduction
|
||||||
|
environments/environments
|
||||||
|
installation/installation
|
||||||
|
basic_deployment/basic_deployment_cli
|
||||||
|
containers_deployment/index
|
||||||
|
post_deployment/post_deployment
|
||||||
|
advanced_deployment/features
|
||||||
|
advanced_deployment/baremetal_nodes
|
||||||
|
advanced_deployment/backends
|
||||||
|
advanced_deployment/custom
|
||||||
|
troubleshooting/troubleshooting
|
||||||
|
validations/validations
|
||||||
|
mistral-api/mistral-api
|
||||||
|
developer/developer
|