Thomas Waldmann
98796a2f0d
replace flake8 by ruff
2023-09-04 22:15:42 +02:00
Thomas Waldmann
1233b47878
sphinx: fix extlinks configuration
...
otherwise sphinx crashes.
2023-02-26 21:32:40 +01:00
Thomas Waldmann
7957af562d
blacken all the code
...
https://black.readthedocs.io/
2022-07-06 16:34:38 +02:00
Thomas Waldmann
cbeef56454
pyupgrade --py38-plus ./**/*.py
2022-02-27 20:11:56 +01:00
Thomas Waldmann
d6756d0070
docs: do not transform --/--- to unicode dashes
2022-02-24 08:44:51 +03:00
Thomas Waldmann
035c175cbb
it's 2022
2022-01-16 23:28:18 +01:00
lyh16
1f8a837303
It's 2021
2021-05-12 21:25:16 +09:00
Thomas Waldmann
45780d87b1
it's 2020
2020-08-13 22:07:02 +02:00
Benedikt Seidl
6a1f31bf29
[DOCS] Add socat pull mode ( #5150 )
...
docs: describe socat pull mode, fixes #900
also: fix sphinx deprecation warning
borg/docs/conf.py:114: RemovedInSphinx40Warning: The app.add_stylesheet() is deprecated. Please use app.add_css_file() instead.
2020-06-23 02:09:35 +02:00
Thomas Waldmann
2713500983
remove -*- coding: ... lines, utf-8 is default for py3
2019-02-22 17:12:05 +01:00
Milkey Mouse
453e4a4b92
Update copyright year
2019-02-19 20:20:13 -08:00
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
