History

yuval brave c04e2084f3 lightos - bugfix compression stats should be True the compression value in get_volume_stats should be ["True", "False"] and not dependent on the configuration: "lightos_default_compression_enabled" if the flag is false, we can not create volume type with compression=True. the backend is filtered in the scheduler. Closes-Bug: #1962221 Signed-off-by: Yuval Brave <yuval@lightbitslabs.com> Change-Id: I09fe872eca1b112f67bad7297de5893696f83373		2022-03-10 18:36:41 +02:00
..
ext	Make docs build parallel	2020-10-22 10:28:01 -05:00
source	lightos - bugfix compression stats should be True	2022-03-10 18:36:41 +02:00
.gitignore	Make doc/source directory compliant with design in spec	2017-07-19 15:59:02 -05:00
README.rst	Update and replace http with https for doc links in Cinder	2017-07-27 09:58:23 +00:00
requirements.txt	Use os-brick 4.3.0	2021-03-25 13:15:43 -04:00

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

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.

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs