manila/doc
Tom Barron 8d1dcb1e0c Updates to support in Ceph local.conf sample
to make user devstack deployment a bit easier.

Since snapshot_support is now on by default for Ceph
backends, enable it in the default share type extra
specs.

Also specify the SHARE_DRIVER so the manila devstack
plugin doesn't think we're running the generic driver
and try to install kernel NFS and samba servers.

Change-Id: I636a047cacba7c5960df15a99fc79a35a818f45d
2020-12-10 15:44:08 -05:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Updates to support in Ceph local.conf sample 2020-12-10 15:44:08 -05:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
requirements.txt Use unittest.mock instead of mock 2020-06-09 01:21:20 +02: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