mirror of
https://github.com/borgbackup/borg.git
synced 2025-02-13 01:45:56 +00:00
explain how to regenerate usage and API files and when
This commit is contained in:
parent
8e36075fe9
commit
811c18dcd4
1 changed files with 17 additions and 0 deletions
|
@ -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
|
||||
-----------------------------
|
||||
|
||||
|
|
Loading…
Reference in a new issue