From 3c535b9d7ab1f49e39c5b5632f97545b147b4b05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Fri, 9 Oct 2015 16:09:25 -0400 Subject: [PATCH 1/3] 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 --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index eba5c841e..66436c171 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,8 @@ sys.path.insert(0, os.path.abspath('..')) from borg import __version__ as sw_version +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. @@ -92,7 +94,11 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'local' +#html_theme = '' +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the From e59045fd242ece0ed09759f577121917cf6303c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Mon, 12 Oct 2015 23:27:59 -0400 Subject: [PATCH 2/3] 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 --- README.rst | 30 +++- docs/_themes/local/sidebarlogo.html | 5 - docs/_themes/local/sidebarusefullinks.html | 20 --- docs/_themes/local/static/favicon.ico | Bin 38926 -> 0 bytes docs/_themes/local/static/local.css_t | 173 --------------------- docs/_themes/local/theme.conf | 6 - 6 files changed, 22 insertions(+), 212 deletions(-) delete mode 100644 docs/_themes/local/sidebarlogo.html delete mode 100644 docs/_themes/local/sidebarusefullinks.html delete mode 100644 docs/_themes/local/static/favicon.ico delete mode 100644 docs/_themes/local/static/local.css_t delete mode 100644 docs/_themes/local/theme.conf diff --git a/README.rst b/README.rst index a43375491..7d550e640 100644 --- a/README.rst +++ b/README.rst @@ -105,12 +105,30 @@ Now doing another backup, just to show off the great deduplication:: For a graphical frontend refer to our complementary project `BorgWeb `_. +Links +----- + + * `Main Web Site `_ + * `Releases `_ + * `PyPI packages `_ + * `ChangeLog `_ + * `GitHub `_ + * `Issue Tracker `_ + * `Bounties & Fundraisers `_ + * `Mailing List `_ + * `License `_ + +Related Projects +---------------- + + * `BorgWeb `_ + * `Atticmatic `_ + * `Attic `_ Notes ----- -Borg is a fork of `Attic `_ and maintained by -"`The Borg collective`_". +Borg is a fork of `Attic`_ and maintained by "`The Borg collective`_". .. _The Borg collective: http://borgbackup.github.io/borgbackup/authors.html @@ -120,20 +138,16 @@ considerations regarding project goals and policy of the Borg project. BORG IS NOT COMPATIBLE WITH ORIGINAL ATTIC. EXPECT THAT WE WILL BREAK COMPATIBILITY REPEATEDLY WHEN MAJOR RELEASE NUMBER CHANGES (like when going from 0.x.y to 1.0.0). Please read the -`changelog`_ (or ``CHANGES.rst`` in the source distribution) for more +`ChangeLog`_ (or ``CHANGES.rst`` in the source distribution) for more information. -.. _changelog: https://borgbackup.github.io/borgbackup/changes.html - NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES. THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS. -Borg is distributed under a 3-clause BSD license, see `the license`_ +Borg is distributed under a 3-clause BSD license, see `License`_ for the complete license. -.. _the license: https://borgbackup.github.io/borgbackup/authors.html#license - |build| |coverage| .. |build| image:: https://travis-ci.org/borgbackup/borg.svg diff --git a/docs/_themes/local/sidebarlogo.html b/docs/_themes/local/sidebarlogo.html deleted file mode 100644 index 20ecf4108..000000000 --- a/docs/_themes/local/sidebarlogo.html +++ /dev/null @@ -1,5 +0,0 @@ - diff --git a/docs/_themes/local/sidebarusefullinks.html b/docs/_themes/local/sidebarusefullinks.html deleted file mode 100644 index c9ae280b2..000000000 --- a/docs/_themes/local/sidebarusefullinks.html +++ /dev/null @@ -1,20 +0,0 @@ -Fork me on GitHub - -

Useful Links

- - -

Related Projects

- - diff --git a/docs/_themes/local/static/favicon.ico b/docs/_themes/local/static/favicon.ico deleted file mode 100644 index 5db148ff4032bd193869b586db71df7ef3fa93b8..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 38926 zcmeI5O^g&p6vu0JKo$f=7C{&J5CjoLQ4n2SSlGqgb$3A)#m^?e5WW&T5j>Ibb>u>V z7fyr(AtaDMLc(XrgaamAxIqFT*`s>$=*ji}ukN>7+jMo$%+9dG@GALJHPx?Qzxws7 z?w(#!V@%HE&8AHT^*l567h_f$gU=24oHGLxjOj#QxV_Q*Ip3H?`;1vk8|XB|{VGs4 z!pCpWAJE^>V4aF%;}|(sj=2(LGMpTN{(|b2Th_QZb}}G~a>~!x>3QZC=Svo3Qc7V? z$NlK%kO|ooQ+|h$GD~MbMrlR!FrA;9U%tHL+;{D?oy{YDz2v<}?>wr-n;o-GHILk70;#K-#I+3 zT&U;wHcyM89;f(utE`lj=78pa=78pa=78pa=78pa=78pa=78pa=78pa=78pa=78ov z={Yb1e^V(yk2BP(e|z!%{iz9TZe{Ru`SvNxM3${3FchBamE{vGr-I39kJ`|G6B2%I z-Hv{}h8D*l2Uh1j9QS2#Y%Iu!SH zAZ91WK9gV@-#6)VQcN7{ENHAaa!fv!N%0DUB#zv61LA$a9e*V`ro}{-&Cponqi~6{ zOpBNM_&6r9tQ5zrn0V}tDsfy0zh@)gJWtd;Ncg$+e)Km$%%yD}o7?E$3(bbMK*u20 zhqO88r$F>oDUQCFuHYEILcIRXhpLf}jqvNvF}9CDGG4dloE#t7^V;QZllF;dyZBt; zv7`Om$hJ}(eKB!75)X4$IS%s>E^e(HlXII~Tuxc-vE(=nvGV!feQrI8&oWQl`Z)UY z5Xa+-xtjC39mfq4v^*oGr!lXyo*#uH*-nh&9Se@UuAPG<9=8@wzH=+v8F#g=kHvCa z=`d7|BhTj@uql?~eb_E_So+R=wdQrL=VK|)Jy*eTT*PuKYIkl)`vLkdKue&bknjB! zpXnw;%XXFuj+DIDGB zN9M;4k6*^s0$uZLXFu<65^oyE4v!BRJM&+jX?-z~$}iQDDEpMrZkQ{9v?}5(>Rv<{W|G5_1>4pvDo|dA)L2-3FodJnU0pD zG7PUDqv5Cwldr+`INx+kdagAGGzT;XGzT;XGzT;XGzT;XGzT;XGzT;XYCQ*Z&6LsS zsH~}5>*u=G*d0>uBn_ zuI1$;bJ1Pbl{u;F442L_zRoZ?vgo?k#k2ISdmWNAM%Q7_W|_4PyRg)}^s~&$Lt!X2 z=e|A<4f7-m-}O+K`D)&acwc{>d2;Mz5Wg>@tE?hxJJ z1^b`G?5DPZ`A_zoTQL7hdqTndBkg>_3`jdSvR#mVELd=GsJ+J99x~B}5~u?L2ZzSs z&-ucT&B(bkApMwA?p$-{pgTAD<Ul)!UDU~s75`Y=?q9imVU z%Hi3}fsyz3#`G&1Z~qNY9vTOYhq%i`XcEM4T2r8@&@`wCnhwo?W9?NA5Q33Wp~P%qR6t%v%d0NMg=g|BABQ~yorTUp=b;PGMd%WA z8M*>pg|0!@p&QUm=oVCfZbNsVyU;!8KJ);32t9%xLt2!85>Nt4KnW-TC7=Y9fD%vw zbxz>ruY;((U8#{y*(5H5U~z?<&KY(Y1n*SF>5KDhd9&a8=J(@@m0Xwg$?w%+S!_RV zemxq-=lQTZx11fbH{hTCm)O-}4c3KQqkpZ@=4n|zgV1T{GV~d2zUb=e`p%B;(+2atZG7`_(|fCJYr~|3I76epPgcI_@%aJ~ zwOR)o$D4Jwu?AhUY%7?a;4?JBn+_k(XT|5_IY{5NcA#zf^s&!>m!&x}N*TN4XArEN zU{ZbNI_;5LOY!*z&P>`lD#z#duT{#YbKcjFGfVC8e(0XLD!iKYO_W?}{<7ysyYYj_ zsC7wC&ri08@7cl<&3DHq@-w&0TFE@xfLD0YJX#QL2-b*E>x!u7E%9hfqED0i&|2DS zNbnV0iqFP&yP=ma46Tv)r0^0~-%ME^uS zN6vTGpp16pb2vXgi>{z$_>x`XJ}cl-&XL4f36~PC)=EGLC;=s)1eAahPy$Lo2`GWu GBk(`O$unC3 diff --git a/docs/_themes/local/static/local.css_t b/docs/_themes/local/static/local.css_t deleted file mode 100644 index ca5ce577e..000000000 --- a/docs/_themes/local/static/local.css_t +++ /dev/null @@ -1,173 +0,0 @@ -@import url("basic.css"); -@import url(//fonts.googleapis.com/css?family=Black+Ops+One); - -body { - font-family: Arial, Helvetica, sans-serif; - background-color: black; - margin: 0; - padding: 0; - position: relative; -} - -div.related { - display: none; - background-color: black; - padding: .4em; - width: 800px; - margin: 0 auto; -} - -div.related a { - color: white; - text-decoration: none; -} - -div.document { - width: 1030px; - margin: 0 auto; -} - -div.documentwrapper { - float: right; - width: 760px; - padding: 0 20px 20px 20px; - color: #00cc00; - background-color: #000000; - margin-bottom: 2em; -} - -div.sphinxsidebar { - margin-left: 0; - padding-right: 20px; - width: 230px; - background: #081008; - position: absolute; - top: 0; - min-height: 100%; -} - -h1, h2, h3 { - font-weight: normal; - color: #33ff33; -} - -h1 { - margin: .8em 0 .5em; - font-size: 200%; -} - -h2 { - margin: 1.2em 0 .6em; - font-size: 140%; -} - -h3 { - margin: 1.2em 0 .6em; - font-size: 110%; -} - -ul { - padding-left: 1.2em; - margin-bottom: .3em; -} - -ul ul { - font-size: 95%; -} - -li { - margin: .1em 0; -} - -a:link { - color: #dddd00; - text-decoration: none; -} - -a:visited { - color: #990000; - text-decoration: none; -} - -a:hover { - color: #dd0000; - border-bottom: 1px dotted #dd0000; -} - -div.sphinxsidebar a:link, div.sphinxsidebar a:visited { - border-bottom: 1px dotted #555; -} - -div.sphinxsidebar { - color: #00cc00; - background: 0000000; -} - -div.sphinxsidebar input { - color: #00ff00; - background: 0000000; - border: 1px solid #444444; -} - -pre { - padding: 10px 20px; - background: #101010; - color: #22cc22; - line-height: 1.5em; - border-bottom: 2px solid black; -} - -pre a:link, -pre a:visited { - color: #00b0e4; -} - -div.sidebarlogo .title { - font-family: 'Black Ops One', cursive; - font-size: 500%; -} - -div.sidebarlogo a { - color: #00dd00; -} - -div.sidebarlogo .subtitle { - font-style: italic; - color: #777; -} - -tt span.pre { - font-size: 110%; -} - -dt { - font-size: 95%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -div.note { - background-color: #002211; - border-bottom: 2px solid #22dd22; -} - -div.seealso { - background-color: #0fe; - border: 1px solid #0f6; - border-radius: .4em; - box-shadow: 2px 2px #dd6; -} diff --git a/docs/_themes/local/theme.conf b/docs/_themes/local/theme.conf deleted file mode 100644 index 03505a6ec..000000000 --- a/docs/_themes/local/theme.conf +++ /dev/null @@ -1,6 +0,0 @@ -[theme] -inherit = basic -stylesheet = local.css -pygments_style = tango - -[options] From f31b4a639b75791806074c429f63d93718a99066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Mon, 12 Oct 2015 23:36:31 -0400 Subject: [PATCH 3/3] fix headings in README this makes it consistent with the rest of the documentation --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 32700cfce..f7327f0ac 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ What is BorgBackup? -------------------- +=================== BorgBackup (short: Borg) is a deduplicating backup program. Optionally, it supports compression and authenticated encryption. @@ -15,7 +15,7 @@ downloaded Borg, ``docs/installation.rst`` to get started with Borg. .. _installation manual: https://borgbackup.readthedocs.org/installation.html Main features -~~~~~~~~~~~~~ +------------- **Space efficient storage** Deduplication based on content-defined chunking is used to reduce the number of bytes stored: each file is split into a number of variable length chunks @@ -82,7 +82,7 @@ Main features Easy to use -~~~~~~~~~~~ +----------- Initialize a new backup repository and create a backup archive:: $ borg init /mnt/backup @@ -106,7 +106,7 @@ For a graphical frontend refer to our complementary project `BorgWeb `_. Links ------ +===== * `Main Web Site `_ * `Releases `_