mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
5,229 Commits 9 Branches 137 Tags 57 MiB
Commit Graph

56 Commits

Author SHA1 Message Date
Thomas Schwinge 2458035057 Mark up Unicode string 
Running Sphinx v1.4.8
    WARNING: the config value 'copyright' is set to a string with non-ASCII characters; this can lead to Unicode errors occurring. Please use Unicode strings, e.g. u'Content'.
    [...]
    Encoding error:
    'ascii' codec can't decode byte 0xc3 in position 23: ordinal not in range(128)
 2018-03-08 11:37:45 +01:00
Abogical 937736ceb9 Happy new year! 2018-01-02 11:10:07 +02:00
Marian Beermann 6290b73863 docs: more compact options formatting 2017-06-20 11:48:46 +02:00
Marian Beermann 3fea2ac05e docs: switch to a fresher theme 
incidentally, fixes font size mismatches on firefox and chrome,
at the same time. marvellous.
 2017-06-18 01:27:29 +02:00
Marian Beermann b08064bb4e docs: turn smartypants back on, since --options are now in `` 2017-06-17 12:29:13 +02:00
Marian Beermann 3664adb95d docs: highlight experimental features in online docs 2017-06-09 14:19:55 +02:00
Marian Beermann e80c0f7c5e docs: fix way too small figures in pdf 2017-06-05 01:01:27 +02:00
Marian Beermann 83fdc39251 docs book: use A4 format, new builder option format. 2017-05-23 10:07:25 +02:00
Marian Beermann acf3842e02 docs: create appendices in the book 2017-05-22 20:55:16 +02:00
enkore 226d1f6094 Revert "docs: borg_domain for custom priority index entries" 2017-05-22 20:45:29 +02:00
Marian Beermann 7284413e3f docs: borg_domain for custom priority index entries 2017-05-22 20:08:11 +02:00
Marian Beermann 7ddc8003df docs: use vector logo for PDF version 2017-05-13 13:19:23 +02:00
Marian Beermann fcce0ca2bc docs: disable smartypants 2017-05-01 22:31:18 +02:00
Martin Hostettler 179f1bc147 Add qr html export mode to `key export` command 2017-02-13 21:24:33 +01:00
Martin Hostettler e0f36e8613 quickstart.rst: Add link to paperkey template. 2017-02-13 20:45:49 +01:00
Abogical f043b966da It's 2017 2016-12-31 16:53:30 +02:00
Marian Beermann 05a52ec8ec
Merge branch '1.0-maint' into merge/1.0-maint 2016-11-09 23:56:54 +01:00
Antoine Beaupré adfd66d636 restore normal size 
otherwise code examples overflow
 2016-11-04 21:27:21 -04:00
Antoine Beaupré aeb10d1a85 show URLs in PDF, better font 2016-11-04 16:01:18 -04:00
Antoine Beaupré 5def2350d0 fix PDF rendering structure 
without those changes, all of the toctree document headings do not
show up. they are considered to be "below" the last heading of the
README file.

we also remove the "Notes" section from the readme as there is only
one note, regarding the fork.

we introduce a stub "introduction" element in the toctree, otherwise
it is impossible for the PDF rendered to render the README correctly.

this is to workaround a bug in the PDF renderer.
 2016-11-04 16:01:18 -04:00
Antoine Beaupré 18f3d64e4c PDF docs: add logo and fix authors 
the PDF documentation looks much better with those
 2016-11-04 15:59:55 -04:00
Thomas Waldmann 3baa8a3728 Merge branch '1.0-maint' 
# Conflicts:
#	docs/changes.rst
#	docs/usage/mount.rst.inc
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/fuse.py
#	src/borg/testsuite/archiver.py
 2016-07-11 01:23:27 +02:00
Thomas Waldmann 5660cd1f96 fix most non-python-source related sphinx warnings 
literal blocks must be followed by an empty line

suppressed the non-local image uri warning via sphinx config

the links on the resources page must have different label texts

setup.py: do not generate pointless "::\n" - it does not create a literal block if the stuff below is not indented
 2016-07-10 17:25:51 +02:00
Thomas Waldmann d62f55158e sphinx: fix sys.path so it finds the borg package 2016-05-30 23:00:33 +02:00
Thomas Waldmann 7420ea0033 sphinx configuration: fix to create a simple man page from usage docs 2016-01-13 01:20:32 +01:00
Thomas Waldmann 4216a94e19 it's 2016 2016-01-13 00:42:23 +01:00
Thomas Waldmann 42e9a77f5b style changes of previous changeset did not work on rtd, try 2 2015-11-20 19:32:04 +01:00
Thomas Waldmann 077bcd0cde logo: have a separate, bigger logo (do not reuse the favicon) 
currently just scaled up / converted to png from the favicon.ico.
 2015-11-20 19:06:40 +01:00
Thomas Waldmann 87bb886705 rtd theme adjustment: borg darkness for the upper left corner 2015-11-20 18:51:11 +01:00
Thomas Waldmann 7a08368b65 fix html_theme_path overriding previous definition of it 2015-11-20 17:56:35 +01:00
Thomas Waldmann 2e64c29e01 use ISO-8601 date and time format, fixes #375 2015-11-16 23:51:21 +01:00
Antoine Beaupré c7c02ef725 fix path to favicon 2015-10-19 12:15:39 -04: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é 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é a2cf0025c2 add automatically generated API 
this is a crude hack for now, and could use a better table of contents

but at least we have some way of linking and showing the different
internal functions

the next phase here is obviously to document that API through the
addition of docstrings. a static api.rst could also be easier to read,
but maybe that could go through some docstrings as well, to be tested
 2015-09-30 18:35:57 -04:00
Per Guth 8cf0ead693 docs: added `favicon.ico` 2015-08-17 12:58:49 +02:00
Per Guth 1c7b5b23f4 minor change in copyright notice 2015-08-17 11:31:42 +02:00
Thomas Waldmann 4c668a85b6 update docs copyright (to be same as project copyright) 2015-08-09 14:16:56 +02:00
Thomas Waldmann dcdcbda87d try if readthedocs finds the borg package this way 2015-08-06 15:17:07 +02:00
Thomas Waldmann e3baeefa1b docs: reorganize sidebar, prev/next at top 2015-08-06 13:10:56 +02:00
Thomas Waldmann 9b9c808713 fixed some minor issues found by pycharm/pytest-flakes 2015-07-15 11:30:25 +02:00
Thomas Waldmann 5e98400a5a fix all references to package name 
use relative imports if possible
reorder imports (1. stdlib 2. dependencies 3. borg 4. borg.testsuite)
 2015-05-22 19:21:41 +02:00
Thomas Waldmann 37c923d4f0 misc. minor docs fixes 2015-05-15 01:50:45 +02:00
Thomas Waldmann cb5c9b63b3 fork: s/attic/borg/g, fix URLs, add new section to AUTHORS 
use borg instead attic except at the places where it was used:
- as toplevel package name, directory name, file name
- to refer to original attic

remove sphinx upload make command, will be replaced by github.io site later

remove references to binary downloads and linux packages for now

remove some software name references, fix grammar

use borgbackup rather than borg-backup (or borg) in URLs,
less name collision issues, better search results, no validity issues with "-"
 2015-05-13 15:02:33 +02:00
Jonas Borgström 7ce3290fb2 docs: Added link to prebuilt Linux binaries. 2014-06-29 14:24:45 +02:00
Jonas Borgström 3a064aba56 Fix sorting of segment names to ignore NFS left over files. 
Closes #17.
 2014-01-03 14:47:44 +01:00
Jonas Borgström 9ebeb0f98d Documentation: Added info about mailing list 2013-08-06 22:17:28 +02:00
Jonas Borgström 3b4875cf2e Start using versioneer for version numbers 2013-08-05 23:05:15 +02:00
Jonas Borgström a51a10a96c More documentation improvements. 2013-08-04 23:20:22 +02:00
Jonas Borgström b6c8392c03 More documentation work 2013-08-03 13:05:06 +02:00