Thomas Waldmann
3a72fbe418
update CHANGES
2015-11-15 20:30:58 +01:00
Thomas Waldmann
0070ef0c4a
minor install docs fixes
2015-11-15 20:23:33 +01:00
TW
eefc137ec9
Merge pull request #412 from anarcat/install-docs-nitpick
...
Install docs nitpick
2015-11-15 20:19:17 +01:00
Thomas Waldmann
234a88bec6
avoid hidden import, make it easy for pyinstaller
...
this fixes #218 in an easier way so one doesn't have to type
--hidden-import=logging.config all the time when using pyinstaller.
2015-11-15 15:52:02 +01:00
Thomas Waldmann
d6b8de943b
add docs for item flags / status output, fixes #402
2015-11-15 14:32:19 +01:00
Antoine Beaupré
aa4c76872c
move pyinstaller mention out of heading
...
pyinstaller probably means nothing for most people, while standalone binary is more meaningful
2015-11-14 21:08:28 -05:00
Antoine Beaupré
a8d2c18fee
split packaging meta-info in a separate paragraph and link to github
2015-11-14 21:07:16 -05:00
Antoine Beaupré
9f8700e383
restructure install page headings
...
do not repeat "installation" all the time, and regroup git and pip under "from source"
also link to the sections in the summary
2015-11-14 21:03:38 -05:00
Thomas Waldmann
fd5ccadcac
update CHANGES
2015-11-14 23:48:44 +01:00
Antoine Beaupré
811c18dcd4
explain how to regenerate usage and API files and when
2015-11-13 10:46:13 -05:00
Antoine Beaupré
8e36075fe9
commit usage files directly into git
...
the generation of those files was causing us way too much pain to
justify automatically generating them all the time.
those will have to be re-generated with `build_api` or `build_usage`
as appropriate, for example when function signatures or commandline
flags change.
see #384
2015-11-13 10:42:52 -05:00
Antoine Beaupré
f13dd6e579
completely remove have_cython() hack
...
this was making us require mock, which is really a test component and
shouldn't be part of the runtime dependencies. furthermore, it was
making the imports and the code more brittle: it may have been
possible that, through an environment variable, backups could be
corrupted because mock libraries would be configured instead of real
once, which is a risk we shouldn't be taking.
finally, this was used only to build docs, which we will build and
commit to git by hand with a fully working borg when relevant.
see #384 .
2015-11-13 10:40:53 -05:00
Thomas Waldmann
4a2e4ec683
update CHANGES
2015-11-08 17:10:18 +01:00
Thomas Waldmann
f48a5ae6a7
fix formatting issue in changes.rst
2015-11-08 02:17:37 +01:00
Thomas Waldmann
cd40ec280d
update CHANGES
2015-11-08 01:29:53 +01:00
Thomas Waldmann
303bed9d12
docs: minor development docs update
2015-11-07 15:17:40 +01:00
Thomas Waldmann
c34ef37516
CHANGES: some fixes, add compatibility notes
2015-11-06 22:04:37 +01:00
Thomas Waldmann
47fec587d4
updated CHANGES
2015-11-06 21:33:43 +01:00
Thomas Waldmann
b1eb784bd1
docs: add section about debug commands
2015-11-06 18:31:06 +01:00
Thomas Waldmann
6c1b765741
docs: group general stuff under 1 headline, fix another headline level
2015-11-06 18:22:30 +01:00
Thomas Waldmann
f6244f006e
docs: warn about not running out of space
2015-11-04 01:51:09 +01:00
Thomas Waldmann
bdf7dc65bd
docs: add example for rename
2015-11-02 20:53:04 +01:00
Thomas Waldmann
734dae80ef
improve chunker params docs, fixes #362
2015-11-02 19:47:09 +01:00
Thomas Waldmann
44083f7f73
updated CHANGES
2015-10-29 16:22:02 +01:00
Thomas Waldmann
b787ac6ea1
docs: remove api docs (too much breakage on rtd)
2015-10-27 20:46:57 +01:00
Thomas Waldmann
a16ae01289
borgbackup install+basics presentation(asciinema + script)
2015-10-24 23:40:51 +02:00
Thomas Waldmann
39fb9b176a
update docs about return codes
2015-10-22 01:40:34 +02:00
TW
a1f88c73aa
Merge pull request #322 from anarcat/docs
...
explicitely commit to the units standard
2015-10-21 15:30:23 +02:00
Antoine Beaupré
76c0804bd5
explicitely commit to the units standard, see #289
2015-10-21 09:25:46 -04:00
Antoine Beaupré
03d381c2f9
describe the current style guide in documentation
2015-10-20 14:43:49 -04:00
Thomas Waldmann
a4f136afba
update CHANGES.rst (add issue / PR numbers)
2015-10-20 16:23:23 +02:00
Thomas Waldmann
344a25c102
update CHANGES.rst
2015-10-20 15:52:22 +02:00
Antoine Beaupré
de9e9d14b7
soften environment security warning to a note, and cross-ref to avoid dupe
2015-10-19 16:25:24 -04:00
Antoine Beaupré
c7c02ef725
fix path to favicon
2015-10-19 12:15:39 -04:00
Antoine Beaupré
5cd5fa72f6
warn users about the environment on multi-user systems
2015-10-19 11:29:22 -04:00
Antoine Beaupré
3d906ab731
word-wrap a bullet list as paragraphs instead
...
it looks nicer that way
2015-10-19 11:17:10 -04:00
Antoine Beaupré
b122fca580
use titles instead of definitions in FAQ
...
this way the titles show up in the table of contents and we can link
to individual entries
2015-10-19 11:12:14 -04:00
Antoine Beaupré
500c2a8a20
fix warnings in docs generation
2015-10-19 11:09:28 -04:00
Antoine Beaupré
780a7d816a
remove mention of "borg" in changelog title
...
we know what we are looking at already...
also demote the attic changelog so it doesn't show in the main table
of contents.
2015-10-19 11:08:19 -04:00
Thomas Waldmann
908e944bdd
include the help offered by borg help <topic> in the usage docs, fixes #293
...
it's not pretty yet, but better than nothing.
2015-10-17 21:53:09 +02:00
TW
0e9c524266
Merge pull request #292 from anarcat/rename-usage
...
add missing rename usage to docs, closes #279
2015-10-17 20:06:23 +02:00
Jakob Schnitzer
7cc3becad9
docs: restructure installation.rst, add OSX instructions
...
Moved the list of dependencies to the corresponding subsection.
Collected all preparation steps under one heading.
Added link to the Arch Linux AUR package.
Install docs for OS X.
2015-10-17 18:40:15 +02:00
Antoine Beaupré
e6c2359a60
add missing rename usage to docs, closes #279
2015-10-17 12:13:59 -04:00
Thomas Waldmann
e7f25d7821
docs: use zlib,6 compression in some examples, fixes #275
...
This is what attic used by default, but borgbackup defaults to "no compression".
I just adjusted the command invocation, so we can keep the example output
(which shows that stuff was compressed).
Also: add FAQ item about compression.
2015-10-16 01:18:37 +02:00
Jakob Schnitzer
da926f2eb4
docs: fix code blocks in installation.rst
...
In one case removed the |project_name| and |git_url| variables to fix
the display of the code block. Shouldn't be problematic, as they are not
used consistently in this document anyway.
Put two notes in their own nice '.. note::' blocks.
2015-10-13 17:25:52 +02:00
Jakob Schnitzer
fb62435fc6
docs: remove 'Additional Notes' from TOC, fix markup
...
What's covered in the 'Additional Notes' section of the documentation
hardly seems important enough to deserve its own entry in the sidebar.
2015-10-13 16:50:27 +02:00
Jakob Schnitzer
b42bbc6f68
docs: fix code blocks
2015-10-13 16:31:25 +02:00
Antoine Beaupré
256f89e697
add back logo, see #272
...
it's ugly as hell, but at least we have some logo there. keeping the issue opened for improvements
2015-10-13 08:35:12 -04:00
Antoine Beaupré
6b604ac28c
Merge remote-tracking branch 'origin/master' into rtd-theme
...
Conflicts:
README.rst
2015-10-12 23:29:45 -04:00
Antoine Beaupré
e59045fd24
move links from the sidebar to the readme
...
it seems sidebar links are not supported by the RTD theme just yet: https://github.com/snide/sphinx_rtd_theme/issues/254
2015-10-12 23:27:59 -04:00
