openstack/manila
Code Issues Proposed changes
a73b299374
manila/doc
History
Takashi Kajinami d3c4e9c31a ratelimit should not be enabled in nolimit pipeline 
This change fixes the wrong instruction in admin guide which enables
ratelimit in the keystone_nolimit pipeline. To use a pipeline with
ratelimit, [DEFAULT] api_rate_limit should be set to True.

Change-Id: I0cfde1c5a18eeb6ace5bc96e728e58954d0ac046
2021-12-27 12:45:13 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source ratelimit should not be enabled in nolimit pipeline 2021-12-27 12:45:13 +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