manila/doc
whoami-rajat 1f005beb58 Add manila-status upgrade check command framework
This adds basic framework for manila-status upgrade
check commands. For now it has only "check_placeholder"
check implemented.
Real checks can be added to this tool in the future.

Change-Id: Id809535d0a01617916a8e29f151ca4e61f738fad
Story: 2003657
Task: 26139
2018-10-19 12:53:03 +05:30
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Add manila-status upgrade check command framework 2018-10-19 12:53:03 +05:30
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