openstack
/
murano
Code Issues Proposed changes
murano/doc/source/first-app
History
Andreas Jaeger dc2fede063 Improve first app builds 
The complete html tree gets published but the .doctree is not needed for
publishing, place it outside of the html tree so that it won't pushed to
the website.

Also, only build html documents.

Fix bug_project, the report a bug URL should point to murano and not to
the api project.

Change-Id: Icf0c901257b452d216d293eb3f1c7b447b58201d
 		2016-10-14 16:51:00 +02:00
..
source Improve first app builds 2016-10-14 16:51:00 +02:00
README.rst [Docs] Add skeleton for My first Murano app guide 2016-10-06 14:14:35 +00:00

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.