From 811c18dcd4b92aed246a46c502b17864e939cb1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Fri, 13 Nov 2015 10:46:13 -0500 Subject: [PATCH] explain how to regenerate usage and API files and when --- docs/development.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/development.rst b/docs/development.rst index a8d664f61..23f28385a 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -61,6 +61,23 @@ Important notes: - When using -- to give options to py.test, you MUST also give borg.testsuite[.module]. +Regenerate usage files +---------------------- + +Usage and API documentation is currently committed directly to git, +although those files are generated automatically from the source +tree. + +When a new module is added, the ``docs/api.rst`` file needs to be +regenerated:: + + ./setup.py build_api + +When a command is added, a commandline flag changed, added or removed, +the usage docs need to be rebuilt as well:: + + ./setup.py build_usage + Building the docs with Sphinx -----------------------------