diff options
| author | Antoine Beaupré <anarcat@koumbit.org> | 2015-09-30 17:42:18 -0400 |
|---|---|---|
| committer | Antoine Beaupré <anarcat@koumbit.org> | 2015-09-30 17:42:18 -0400 |
| commit | 50e7d0f345c85db9a86e0ea2c8991e61095ddbf3 (patch) | |
| tree | d201d75589455b6dd4fc653f7c7862b0be39d96e /docs | |
| parent | e3433f433ca0ee33959708cb8bcbd4263215eefc (diff) | |
more human-readable output in usage generation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 15 | ||||
| -rw-r--r-- | docs/api.rst | 6 |
2 files changed, 14 insertions, 7 deletions
diff --git a/docs/Makefile b/docs/Makefile index 1aaf1cf7e..1f3f7d76c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -145,10 +145,11 @@ usage: $(shell borg help | grep -A1 "Available commands:" | tail -1 | sed 's/[{} # generate help file based on usage usage/%.rst.inc: ../borg/archiver.py - printf ".. _borg_$*:\n\n" > $@ - printf "borg $*\n" >> $@ - echo -n borg $* | tr 'a-z- ' '-' >> $@ - printf "\n::\n\n" >> $@ - borg help $* --usage-only | sed -e 's/^/ /' >> $@ - printf "\nDescription\n~~~~~~~~~~~\n" >> $@ - borg help $* --epilog-only >> $@ + @echo generating usage for $* + @printf ".. _borg_$*:\n\n" > $@ + @printf "borg $*\n" >> $@ + @echo -n borg $* | tr 'a-z- ' '-' >> $@ + @printf "\n::\n\n" >> $@ + @borg help $* --usage-only | sed -e 's/^/ /' >> $@ + @printf "\nDescription\n~~~~~~~~~~~\n" >> $@ + @borg help $* --epilog-only >> $@ diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 000000000..c535aa970 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,6 @@ +Borg Backup API documentation +============================= + +.. automodule:: borg + :members: + :undoc-members: |