Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

switch to default rtd theme #268

Merged
merged 4 commits into from
Oct 13, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
What is BorgBackup?
-------------------
===================
BorgBackup (short: Borg) is a deduplicating backup program.
Optionally, it supports compression and authenticated encryption.

Expand All @@ -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
Expand Down Expand Up @@ -82,7 +82,7 @@ Main features


Easy to use
~~~~~~~~~~~
-----------
Initialize a new backup repository and create a backup archive::

$ borg init /mnt/backup
Expand All @@ -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: https://borgbackup.readthedocs.org/authors.html

Expand All @@ -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.readthedocs.org/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.readthedocs.org/authors.html#license

|build| |coverage|

.. |build| image:: https://travis-ci.org/borgbackup/borg.svg
Expand Down
5 changes: 0 additions & 5 deletions docs/_themes/local/sidebarlogo.html

This file was deleted.

20 changes: 0 additions & 20 deletions docs/_themes/local/sidebarusefullinks.html

This file was deleted.

Binary file removed docs/_themes/local/static/favicon.ico
Binary file not shown.
173 changes: 0 additions & 173 deletions docs/_themes/local/static/local.css_t

This file was deleted.

6 changes: 0 additions & 6 deletions docs/_themes/local/theme.conf

This file was deleted.

8 changes: 7 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

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.
Expand Down Expand Up @@ -92,7 +94,11 @@

# 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
Expand Down