From d4d8f672a52f01813cb70154f3dfa75aa844b2e8 Mon Sep 17 00:00:00 2001 From: Niels Thykier Date: Fri, 4 May 2018 05:45:16 +0000 Subject: [PATCH] Document how to build the documentation Signed-off-by: Niels Thykier --- doc/contributing-to-britney.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/contributing-to-britney.rst b/doc/contributing-to-britney.rst index 3e82840..af6d8c6 100644 --- a/doc/contributing-to-britney.rst +++ b/doc/contributing-to-britney.rst @@ -33,8 +33,13 @@ The `runtests` command in `britney2-tests` supports running only a subset of the tests. Please see its `--help` output for more information. -Finally, there is also some heavier tests based on some snapshots of +There are also some heavier tests based on some snapshots of live data from Debian. The data files for these are available in the `live-data` submodule of the `britney2-tests` repo. They consume quite a bit of disk space and britney will need at least 1.3GB of RAM to process them. + + +Documentation is handled by sphinx and can be built bia:: + + make html