Documentation update
Change-Id: I4680c7e9e18454198e7a3b1dd304a627ca176465
This commit is contained in:
Samir Ibradžić
parent
09e1b36d90
commit
0e10ae5dc9
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -22,7 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'reno.sphinxext',
|
||||
# 'reno.sphinxext',
|
||||
'rst2pdf.pdfbuilder'
|
||||
]
|
||||
|
||||
|
|
@ -40,13 +40,14 @@ master_doc = 'index'
|
|||
project = u'fuel-midonet-plugin'
|
||||
copyright = u'2016, Midokura SARL'
|
||||
version = '4.0.0'
|
||||
release = version[:3] + '-' + version + '-1'
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
add_function_parentheses = True
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
add_module_names = True
|
||||
#add_module_names = True
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
|
@ -56,9 +57,8 @@ pygments_style = 'sphinx'
|
|||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||
# html_theme_path = ["."]
|
||||
# html_theme = '_theme'
|
||||
# html_static_path = ['static']
|
||||
# html_theme = 'default'
|
||||
html_theme = 'default'
|
||||
# html_static_path = ['_static']
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '%sdoc' % project
|
||||
|
|
@ -69,11 +69,14 @@ htmlhelp_basename = '%sdoc' % project
|
|||
latex_documents = [
|
||||
('index',
|
||||
'%s.tex' % project,
|
||||
u'%s Documentation' % project,
|
||||
u'Guide to the MidoNet Plugin',
|
||||
u'OpenStack Foundation', 'manual'),
|
||||
]
|
||||
|
||||
latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
|
||||
|
||||
pdf_documents = [(master_doc, project, u'MidoNet plugin for Fuel 8', copyright),]
|
||||
pdf_inline_footnotes = True
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
#intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@ Fuel |FuelVer|
|
|||
MidoNet plugin for Fuel |PluginVer|
|
||||
======================= ===============
|
||||
|
||||
.. _known_limitations:
|
||||
|
||||
Known Limitations
|
||||
-----------------
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ MidoNet Fuel Plugin User Guide
|
|||
==============================
|
||||
|
||||
Once the Fuel MidoNet plugin has been installed (following
|
||||
`Installation Guide`_), you can create *OpenStack* environments that use
|
||||
:ref:`Installation Guide <installation_guide>`), you can create *OpenStack* environments that use
|
||||
MidoNet SDN controller as a Neutron back-end.
|
||||
|
||||
MidoNet Networks
|
||||
|
|
@ -245,7 +245,7 @@ the deployment went fine, please see `MidoNet Troubleshooting Guide`_.
|
|||
|
||||
.. _MidoNet Operations Guide: https://docs.midonet.org/docs/v2015.06/en/operations-guide/content/index.html
|
||||
.. _MidoNet Troubleshooting Guide: https://docs.midonet.org/docs/v2015.06/en/troubleshooting-guide/content/index.html
|
||||
.. _`Connectivity Check`: https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#verify-networks
|
||||
.. _`Connectivity Check`: https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html#network-issues
|
||||
|
||||
|
||||
|
||||
|
|
@ -254,7 +254,7 @@ Troubleshooting MidoNet Fuel deployment
|
|||
|
||||
In a case MidoNet Fuel deployment failed for some reason, first thing to
|
||||
do is to make sure that the initiated deployment satisfies the plugin
|
||||
`Known Limitations`_.
|
||||
:ref:`Known Limitations<known_limitations>`.
|
||||
|
||||
In a case MidoNet Fuel deployment failed for some other reason, useful thing
|
||||
to be checked are various log outputs available in Fuel WEB UI. Click on the
|
||||
|
|
|
|||
|
|
@ -1,52 +1,22 @@
|
|||
.. |FuelVer| replace:: 8.0
|
||||
.. |PrevPluginVer| replace:: 3.0.1
|
||||
.. |PluginVer| replace:: 4.0.0
|
||||
|
||||
|
||||
Document purpose
|
||||
================
|
||||
|
||||
This document will guide you through the steps of install, configure and use the
|
||||
MidoNet plugin version |PluginVer| for Fuel |FuelVer|.
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak oneColumn
|
||||
|
||||
Contents
|
||||
========
|
||||
===========================
|
||||
Guide to the MidoNet Plugin
|
||||
===========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
description
|
||||
terms
|
||||
installation
|
||||
guide
|
||||
appendixes
|
||||
revisions
|
||||
description
|
||||
terms
|
||||
installation
|
||||
guide
|
||||
appendixes
|
||||
|
||||
Revision history
|
||||
================
|
||||
|
||||
========= =============== ========================== =========================
|
||||
Version Revision date Editor Comment
|
||||
========= =============== ========================== =========================
|
||||
0.1 15.01.2016 Carmela Rubinos Initial release
|
||||
|
||||
(carmela@midokura.com)
|
||||
0.2 29.02.2016 Samir Ibradzic Version 3.0.1 changes
|
||||
|
||||
(samir@midokura.com)
|
||||
0.3 07.03.2016 Samir Ibradzic Added release notes
|
||||
and troubleshooting
|
||||
(samir@midokura.com)
|
||||
4.0 24.03.2016 Jaume Devesa Adapt to Fuel 8
|
||||
|
||||
(jaume@midokura.com)
|
||||
========= =============== ========================== =========================
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak oneColumn
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
|
||||
PageBreak oneColumn
|
||||
|
||||
.. _installation_guide:
|
||||
|
||||
Installation Guide
|
||||
==================
|
||||
|
|
@ -26,7 +27,7 @@ To install the MidoNet Fuel plugin:
|
|||
# fuel plugins
|
||||
id | name | version | package_version
|
||||
---|---------|---------|----------------
|
||||
9 | midonet | 4.0.1 | 4.0.0
|
||||
9 | midonet | 4.0.0 | 4.0.0
|
||||
|
||||
.. _`Fuel Plugin Catalog`: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/
|
||||
.. _`Fuel CLI`: https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#using-fuel-cli
|
||||
|
|
|
|||
|
|
@ -0,0 +1,33 @@
|
|||
.. |FuelVer| replace:: 8.0
|
||||
.. |PrevPluginVer| replace:: 3.0.1
|
||||
.. |PluginVer| replace:: 4.0.0
|
||||
|
||||
Document purpose
|
||||
================
|
||||
|
||||
This document will guide you through the steps of install, configure and use the
|
||||
MidoNet plugin version |PluginVer| for Fuel |FuelVer|.
|
||||
|
||||
|
||||
Revision history
|
||||
----------------
|
||||
|
||||
========= =============== ========================== =========================
|
||||
Version Revision date Editor Comment
|
||||
========= =============== ========================== =========================
|
||||
0.1 15.01.2016 Carmela Rubinos Initial release
|
||||
|
||||
(carmela@midokura.com)
|
||||
0.2 29.02.2016 Samir Ibradzic Version 3.0.1 changes
|
||||
|
||||
(samir@midokura.com)
|
||||
0.3 07.03.2016 Samir Ibradzic Added release notes
|
||||
and troubleshooting
|
||||
(samir@midokura.com)
|
||||
4.0 24.03.2016 Jaume Devesa Adapt to Fuel 8
|
||||
|
||||
(jaume@midokura.com)
|
||||
4.1 09.05.2016 Samir Ibradzic Formatting changes
|
||||
|
||||
(samir@midokura.com)
|
||||
========= =============== ========================== =========================
|
||||
Loading…
Reference in New Issue