Przeglądaj źródła

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
Antoine Beaupré 9 lat temu
rodzic
commit
e59045fd24

+ 22 - 8
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 <https://github.com/borgbackup/borgweb>`_.
 
+Links
+-----
+
+ * `Main Web Site <https://borgbackup.readthedocs.org/>`_
+ * `Releases <https://github.com/borgbackup/borg/releases>`_
+ * `PyPI packages <https://pypi.python.org/pypi/borgbackup>`_
+ * `ChangeLog <https://github.com/borgbackup/borg/blob/master/CHANGES.rst>`_
+ * `GitHub <https://github.com/borgbackup/borg>`_
+ * `Issue Tracker <https://github.com/borgbackup/borg/issues>`_
+ * `Bounties & Fundraisers <https://www.bountysource.com/teams/borgbackup>`_
+ * `Mailing List <http://librelist.com/browser/borgbackup/>`_
+ * `License <https://borgbackup.github.io/borgbackup/authors.html#license>`_
+
+Related Projects
+----------------
+
+ * `BorgWeb <https://borgbackup.github.io/borgweb/>`_
+ * `Atticmatic <https://github.com/witten/atticmatic/>`_
+ * `Attic <https://github.com/jborg/attic>`_
 
 Notes
 -----
 
-Borg is a fork of `Attic <https://github.com/jborg/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

+ 0 - 5
docs/_themes/local/sidebarlogo.html

@@ -1,5 +0,0 @@
-<div class="sidebarlogo">
-  <a href="{{ pathto('index') }}">
-  <div class="title">Borg</div>
-</a>
-</div>

+ 0 - 20
docs/_themes/local/sidebarusefullinks.html

@@ -1,20 +0,0 @@
-<a href="https://github.com/borgbackup/borg"><img style="position: fixed; top: 0; right: 0; border: 0;"
-  src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"></a>
-
-<h3>Useful Links</h3>
-<ul>
-  <li><a href="https://borgbackup.readthedocs.org/">Main Web Site</a></li>
-  <li><a href="https://github.com/borgbackup/borg/releases">Releases</a></li>
-  <li><a href="https://pypi.python.org/pypi/borgbackup">PyPI packages</a></li>
-  <li><a href="https://github.com/borgbackup/borg/blob/master/CHANGES.rst">Current ChangeLog</a></li>
-  <li><a href="https://github.com/borgbackup/borg">GitHub</a></li>
-  <li><a href="https://github.com/borgbackup/borg/issues">Issue Tracker</a></li>
-  <li><a href="https://www.bountysource.com/teams/borgbackup">Bounties &amp; Fundraisers</a></li>
-  <li><a href="http://librelist.com/browser/borgbackup/">Mailing List</a></li>
-</ul>
-
-<h3>Related Projects</h3>
-<ul>
-  <li><a href="https://borgbackup.github.io/borgweb/">BorgWeb</a></li>
-</ul>
-

BIN
docs/_themes/local/static/favicon.ico


+ 0 - 173
docs/_themes/local/static/local.css_t

@@ -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;
-}

+ 0 - 6
docs/_themes/local/theme.conf

@@ -1,6 +0,0 @@
-[theme]
-inherit = basic
-stylesheet = local.css
-pygments_style = tango
-
-[options]