openstack
/
manila
Code Issues Proposed changes
manila/doc
History
silvacarloss 2e4ac3f4bf Add documentation for share server limits 
Updates the manila administrator reference in order to include more
information for the new share server limits
``max_share_server_size`` and ``max_shares_per_share_server``.

Change-Id: I2c4c8f1788471d51b72fa1e1e4434d3a9dba595b
Closes-Bug: #1923486
(cherry picked from commit 05256befb1)
 		2021-08-31 07:13:19 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Add documentation for share server limits 2021-08-31 07:13:19 +00: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

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