Files

liuyamin bc1fc3a307 Update docs landing page to follow guideline

During the rocky cycle, there was a docs-spec approved [0] with the
goal of having a recommended consistent documentation landing page
for all projects.

This updates our docs landing page to follow the structure described
in that recommendation.

[0] http://specs.openstack.org/openstack/docs-specs/specs/rocky/front-page-template.html

Change-Id: Ie2d2a2c06ef0ffe32a80eac85313ab57020af5ba

2019-03-01 01:10:15 +00:00

ext

doc migration: openstackdocstheme completion

2017-08-24 09:15:18 -04:00

source

Update docs landing page to follow guideline

2019-03-01 01:10:15 +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

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