History

With newer sphinx the pdf build fails and gives the following error:

! Dimension too large.

This could be memory issue, that can be fixed by not generating the
sample_policy file as that can be large.

This patch also sets back the tox-docs job as voting.

Closes-Bug: #1918707
Change-Id: I4f22fe7b45394045f672d5bbd3b46c4e5e4b2fd3

2021-06-11 21:06:09 +02:00

ext

doc migration: openstackdocstheme completion

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

source

Fix PDF build

2021-06-11 21:06:09 +02: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