aafd1f0a9d
This commit sets warning-is-error for sphinx_build in setup.cfg and also fixes multiple warnings to make the build pass * Removed :option: see https://docs.openstack.org/contributor-guide/rst-conv/inline-markups.html#option * Removed stale and unreferenced documents * Marked telnet_example as orphan * Added first-app to the index * multiple code-block fixes Change-Id: I9c659860fcb4f29fba5f7f07a6a952becfc354da |
||
|---|---|---|
| .. | ||
| source | ||
| README.rst | ||
README.rst
My first Murano App getting started guide
This directory contains the "My first Murano App getting started guide" tutorial.
The tutorials work with an application that can be found in the openstack/murano-apps repository.
Prerequisites
To build the documentation, you must install the Graphviz package.
/source
The /source directory contains the tutorial
documentation as reStructuredText
(RST).
To build the documentation, you must install Sphinx and the OpenStack
docs.openstack.org Sphinx theme (openstackdocstheme). When you
invoke tox, these dependencies are automatically pulled in from the
top-level test-requirements.txt.
You must also install Graphviz on your build system.
The following command invokes sphinx-build with
murano-firstapp:
tox -e murano-firstapp/samples
The code samples in this guide are located in this directory.
/build/murano-firstapp
The HTML documentation is built in this directory. The
.gitignore file for the project specifies this
directory.