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
Antoine Beaupré
3c535b9d7a
switch to default rtd theme
...
this still doesn't quite work: our sidebar is gone, so no more useful
links and related projects. we also loose the link to github and the
RTD popup, although the latter still needs to be confirmed on RTD
infra
2015-10-09 16:09:27 -04:00
Antoine Beaupré
da2ec7995f
fix homepage URL in all remaining places
...
we update the documentation to mention the automatic updates, and also
remove the hack in the makefile to update the github.io pages, which
are gone.
2015-10-09 15:54:04 -04:00
anarcat
80f82efcdf
Merge pull request #262 from anarcat/rtfd-fixup
...
fix build on readthedocs.org
2015-10-08 16:54:44 -04:00
Antoine Beaupré
7ba4d47f6e
clarify the class name part
2015-10-08 15:31:46 -04:00
Antoine Beaupré
2f803b6489
fix typo, split sentence
2015-10-08 15:31:46 -04:00
anarcat
1c997ea169
Merge pull request #261 from anarcat/docs-readme
...
bunch of docs reshuffling
2015-10-08 09:00:10 -04:00
Antoine Beaupré
6f9e04bc21
generalise the cython check hack
...
instead of applying this only to usage generation, use it as a generic
mechanism to disable loading of Cython code.
it may be incomplete: there may be other places where Cython code is
loaded that is not checked, but that is sufficient to build the usage
docs. the environment variable used is documented as such in the
docs/usage.rst.
we also move the check to a helper function and document it
better. this has the unfortunate side effect of moving includes
around, but I can't think of a better way.
2015-10-08 08:56:02 -04:00
Antoine Beaupré
da02f373c7
Revert "main website becomes RTD, main website link is pointless"
...
Instead, we put the readthedocs.org site as main website.
This reverts commit 8fe56f001c
2015-10-08 08:24:57 -04:00
Antoine Beaupré
8fe56f001c
main website becomes RTD, main website link is pointless
2015-10-07 21:10:09 -04:00
Antoine Beaupré
13d3568548
move usage generation to setup.py
...
this is an unfortunate rewrite of the manpage creation code mentionned
in #208 . ideally, this would be rewritten into a class that can
generate both man pages and .rst files.
2015-10-07 21:07:15 -04:00
Antoine Beaupré
4787424a66
move API generation to setup.py
2015-10-07 19:58:24 -04:00
Antoine Beaupré
60afc03d33
move authors to a stub, include LICENSE
2015-10-07 18:33:31 -04:00
Antoine Beaupré
60d04b05a0
show the README on the homepage
...
instead of a boring table of contents, try to show our more exciting README file
it's still a wall of text, but at least all the buzzwords and highlights are there
ideally, the table of contents would be in the sidebar, but i don't know how to do that
2015-10-07 17:56:24 -04:00
Antoine Beaupré
715a25802e
fix syntax errors in changelog
2015-10-07 17:54:43 -04:00
Antoine Beaupré
b87be856f9
include authors, and move to docs
...
also keep a symlink for backwards compatibility
2015-10-07 17:54:43 -04:00
Antoine Beaupré
3f2d3a8c93
remove unneeded rst boilerplate
...
include CHANGES.rst directly, use a symlink to keep backwards compat
2015-10-07 17:54:43 -04:00
Thomas Waldmann
047e003099
docs: more details about release process, reordered sections
2015-10-07 16:55:42 +02:00
Antoine Beaupré
cec8e18d2b
gpg can't sign multiple files at once, use a loop
2015-10-07 10:17:35 -04:00
Antoine Beaupré
48c8186592
detail what needs to happen in the github release
2015-10-07 10:16:07 -04:00
Antoine Beaupré
bb9b31e265
Revert "new proposal: formal release notes"
...
This reverts commit 4dca50fafa
2015-10-07 10:12:56 -04:00
Antoine Beaupré
a49029db13
s/look/find/
2015-10-07 10:08:00 -04:00
Antoine Beaupré
ebe2e397f7
-them
2015-10-07 10:01:12 -04:00
Antoine Beaupré
74338f8a82
update where twitter is
2015-10-07 09:59:30 -04:00
Antoine Beaupré
d375a69689
fix rst formatting warnings
2015-10-07 09:54:40 -04:00
Antoine Beaupré
4dca50fafa
new proposal: formal release notes
...
this integrates the ideas in #214 to have a small checklist of things to send in the announcements on the mailing list and on the github release
2015-10-07 09:48:52 -04:00
Antoine Beaupré
2259bc050c
more reshuffling of release docs
...
mention that binaries should be signed
clarify where release milestones
reword all steps to be executive
2015-10-07 09:48:52 -04:00
