a17640aab6
The ".. sidebar::" directive generates a <div class="sidebar"> which is expected to float to the right of the text. This adds the CSS from the oslosphinx theme to support it. Change-Id: If03ea2a3892746a0590f831989b2ada4a1850385
171 lines
4.1 KiB
ReStructuredText
171 lines
4.1 KiB
ReStructuredText
.. highlight: python
|
|
:linenothreshold: 5
|
|
|
|
.. figure:: figures/doc-logo-fox.jpg
|
|
:alt: Documentation Logo
|
|
:scale: 30%
|
|
:align: center
|
|
|
|
Demo documentation
|
|
==================
|
|
|
|
The demo documentation provides example markup for looking at the expected output.
|
|
|
|
.. sidebar:: Sidebar
|
|
|
|
This is a sidebar which may be used to provide related or reference
|
|
material. It is displayed in proximity to, but outside the main
|
|
text.
|
|
|
|
The project aims for simple implementation, massive scalability, and a rich set
|
|
of features. Cloud computing experts from around the world contribute to the project.
|
|
|
|
Glossary
|
|
~~~~~~~~
|
|
|
|
Here's an example glossary:
|
|
|
|
Cactus
|
|
An OpenStack grouped release of projects that came out in the spring of
|
|
2011. It included Compute (nova), Object Storage (swift), and the Image
|
|
service (glance). Cactus is a city in Texas, US and is the code name for
|
|
the third release of OpenStack. When OpenStack releases went from three to
|
|
six months long, the code name of the release changed to match a geography
|
|
nearest the previous summit.
|
|
|
|
CADF
|
|
Cloud Auditing Data Federation (CADF) is a specification for audit event
|
|
data. CADF is supported by OpenStack Identity.
|
|
|
|
CALL
|
|
One of the RPC primitives used by the OpenStack message queue software.
|
|
Sends a message and waits for a response.
|
|
|
|
Literal Blocks
|
|
~~~~~~~~~~~~~~
|
|
|
|
Here's an example configuration::
|
|
|
|
[DEFAULT]
|
|
...
|
|
my_ip = 10.0.0.31
|
|
vnc_enabled = True
|
|
vncserver_listen = 0.0.0.0
|
|
vncserver_proxyclient_address = 10.0.0.31
|
|
novncproxy_base_url = http://controller:6080/vnc_auto.html
|
|
|
|
Code Blocks
|
|
~~~~~~~~~~~
|
|
|
|
Here's another example that's python code:
|
|
|
|
.. code-block:: python
|
|
:linenos:
|
|
|
|
def builder_inited(app):
|
|
theme_dir = os.path.join(os.path.dirname(__file__), 'theme')
|
|
app.info('Using openstack theme from %s' % theme_dir)
|
|
# Insert our theme directory at the front of the search path and
|
|
# force the theme setting to use the one in the package. This is
|
|
# done here, instead of in setup(), because conf.py is read after
|
|
# setup() runs, so if the conf contains these values the user
|
|
# values overwrite these. That's not bad for the theme, but it
|
|
# breaks the search path.
|
|
app.config.html_theme_path.insert(0, theme_dir)
|
|
# Set the theme name
|
|
app.config.html_theme = 'openstack'
|
|
# Re-initialize the builder, if it has the method for setting up
|
|
# the templates and theme.
|
|
if hasattr(app.builder, 'init_templates'):
|
|
app.builder.init_templates()
|
|
|
|
Here's the same example but with ..code-block: ini to test the pygments lexer:
|
|
|
|
.. code-block:: ini
|
|
|
|
[DEFAULT]
|
|
...
|
|
my_ip = 10.0.0.31
|
|
vnc_enabled = True
|
|
vncserver_listen = 0.0.0.0
|
|
vncserver_proxyclient_address = 10.0.0.31
|
|
novncproxy_base_url = http://controller:6080/vnc_auto.html
|
|
|
|
Notices
|
|
~~~~~~~
|
|
|
|
Notices take these forms.
|
|
|
|
note
|
|
++++
|
|
|
|
.. note:: A comment with additional information that explains a part of the
|
|
text.
|
|
|
|
important
|
|
+++++++++
|
|
|
|
.. important:: Something you must be aware of before proceeding.
|
|
|
|
tip
|
|
+++
|
|
|
|
.. tip:: An extra but helpful piece of practical advice.
|
|
|
|
caution
|
|
+++++++
|
|
|
|
.. caution:: Helpful information that prevents the user from making mistakes.
|
|
|
|
seealso
|
|
+++++++
|
|
|
|
.. seealso::
|
|
|
|
A reference to another piece of related information, like a
|
|
related setting or upstream documentation
|
|
|
|
warning
|
|
+++++++
|
|
|
|
.. warning:: Critical information about the risk of data loss or security
|
|
issues.
|
|
|
|
Configuration addition and deprecation notices
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. versionadded:: 9.0.0-Mitaka
|
|
|
|
.. versionadded:: 10.0.0-Newton
|
|
|
|
.. versionchanged:: 10.0.0-Newton
|
|
|
|
Added support for new tags!
|
|
|
|
.. versionchanged:: 11.0.0-Ocata
|
|
|
|
Showing that multiple notices work!
|
|
|
|
.. deprecated:: 11.0.0-Ocata
|
|
|
|
Use `Notices`_ instead.
|
|
|
|
.. deprecated:: 12.0.0-Pike
|
|
|
|
A second deprecation notice
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
section_dashboard_access_and_security
|
|
dashboard_demo
|
|
configure_access_and_security_for_instances
|
|
create_and_manage_databases
|
|
create_and_manage_networks
|
|
launch-instance
|
|
|
|
Search
|
|
~~~~~~
|
|
|
|
* :ref:`search`
|