History

Andreas Jaeger cef3bee057 Change PDF file name

The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.

Follow this rename.

Change-Id: I98d52f3b259cfffeb0e8ec996279ad4ff782276d

2019-09-04 06:46:25 +02:00

ext

doc migration: openstackdocstheme completion

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

source

Change PDF file name

2019-09-04 06:46:25 +02:00

README.rst

Update the documentation link for doc migration

2017-07-14 07:27:16 +00:00

requirements.txt

Bump the openstackdocstheme extension to 1.20

2019-07-01 15:30:47 +08: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