openstack/manila
Code Issues Proposed changes
bf3a83b46c
manila/doc
History
Carlos Eduardo bf3a83b46c Add CephFS Manage/unmanage documentation 
- Updates the drivers support matrix
- Updates the CephFS drivers documentation and highlight how the
process works and what are the known limitations.

Change-Id: I2f937358e93271fc5ad63e76cc4a9c5aa0ba3017
(cherry picked from commit 4fe2b014e5)
2024-10-02 21:15:01 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Add CephFS Manage/unmanage documentation 2024-10-02 21:15:01 +00:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
requirements.txt Remove old excludes 2024-05-01 11:20:23 +09: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