openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Luigi Toscano e02a625e9c Use the canonical URL for Manila repositories 
- When the URL refers to cloning or using git repositories, use the
  cloning URL (https://git.openstack.org/openstack/<project>)
- When the URL refers to the browsable version of the repository, use
  the cgit frontend (https://git.openstack.org/cgit/openstack/<project>)

Change-Id: I11a8e15c6d663786465c090b40db9e20b19194e6
 		2018-12-17 13:56:17 +01:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Use the canonical URL for Manila repositories 2018-12-17 13:56:17 +01:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
requirements.txt Updated from global requirements 2018-03-23 01:06:24 +00:00

README.rst

Manila Development Docs

Files under this directory tree are used for generating the documentation for the manila source code.

Developer documentation is built to: https://docs.openstack.org/manila/latest/

Tools

Sphinx

The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.

Graphviz

Some of the diagrams are generated using the dot language from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs