manila/doc
Goutham Pacha Ravi 0f627aa6cf Deprecate [DEFAULT]/share_usage_size_audit_period
This option is unused and is likely going to confuse
deployers, especially when using the share usage size
tracking feature with a similarly named option
(share_usage_size_update_interval) [1].

We can remove this option in the Train release.

Closes-Bug: #1813054
[1] https://review.openstack.org/#/c/465055/

Change-Id: Id4585fa887e5bdfd5743dad2c490392ba0401061
2019-01-24 16:04:54 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Deprecate [DEFAULT]/share_usage_size_audit_period 2019-01-24 16:04:54 +00: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

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