mirror of
https://github.com/borgbackup/borg.git
synced 2025-02-21 21:57:36 +00:00
Merge remote-tracking branch 'origin/master' into rtd-theme
Conflicts: README.rst
This commit is contained in:
commit
6b604ac28c
4 changed files with 9 additions and 21 deletions
|
@ -12,7 +12,7 @@ fully trusted targets.
|
||||||
See the `installation manual`_ or, if you have already
|
See the `installation manual`_ or, if you have already
|
||||||
downloaded Borg, ``docs/installation.rst`` to get started with Borg.
|
downloaded Borg, ``docs/installation.rst`` to get started with Borg.
|
||||||
|
|
||||||
.. _installation manual: http://borgbackup.github.io/borgbackup/installation.html
|
.. _installation manual: https://borgbackup.readthedocs.org/installation.html
|
||||||
|
|
||||||
Main features
|
Main features
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
@ -130,7 +130,7 @@ 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
|
.. _The Borg collective: https://borgbackup.readthedocs.org/authors.html
|
||||||
|
|
||||||
Read `issue #1 <https://github.com/borgbackup/borg/issues/1>`_ about the initial
|
Read `issue #1 <https://github.com/borgbackup/borg/issues/1>`_ about the initial
|
||||||
considerations regarding project goals and policy of the Borg project.
|
considerations regarding project goals and policy of the Borg project.
|
||||||
|
|
|
@ -128,14 +128,3 @@ doctest:
|
||||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||||
@echo "Testing of doctests in the sources finished, look at the " \
|
@echo "Testing of doctests in the sources finished, look at the " \
|
||||||
"results in $(BUILDDIR)/doctest/output.txt."
|
"results in $(BUILDDIR)/doctest/output.txt."
|
||||||
|
|
||||||
gh-io: html
|
|
||||||
GH_IO_CLONE="`mktemp -d`" && \
|
|
||||||
git clone git@github.com:borgbackup/borgbackup.github.io.git $$GH_IO_CLONE && \
|
|
||||||
(cd $$GH_IO_CLONE && git rm -r *) && \
|
|
||||||
cp -r _build/html/* $$GH_IO_CLONE && \
|
|
||||||
(cd $$GH_IO_CLONE && git add -A && git commit -m 'Updated borgbackup.github.io' && git push) && \
|
|
||||||
rm -rf $$GH_IO_CLONE
|
|
||||||
|
|
||||||
inotify: html
|
|
||||||
while inotifywait -r . --exclude usage.rst --exclude '_build/*' ; do make html ; done
|
|
||||||
|
|
|
@ -68,10 +68,8 @@ Now run::
|
||||||
|
|
||||||
Then point a web browser at docs/_build/html/index.html.
|
Then point a web browser at docs/_build/html/index.html.
|
||||||
|
|
||||||
To update the web site, copy (and add, commit and push) the contents of the
|
The website is updated automatically through Github web hooks on the
|
||||||
`_build` directory to the `borgbackup` directory in the web site's repository:
|
main repository.
|
||||||
https://github.com/borgbackup/borgbackup.github.io
|
|
||||||
|
|
||||||
|
|
||||||
Using Vagrant
|
Using Vagrant
|
||||||
-------------
|
-------------
|
||||||
|
|
9
setup.py
9
setup.py
|
@ -111,7 +111,7 @@ def detect_lz4(prefixes):
|
||||||
|
|
||||||
possible_lz4_prefixes = ['/usr', '/usr/local', '/usr/local/opt/lz4', '/usr/local/lz4', '/usr/local/borg', '/opt/local']
|
possible_lz4_prefixes = ['/usr', '/usr/local', '/usr/local/opt/lz4', '/usr/local/lz4', '/usr/local/borg', '/opt/local']
|
||||||
if os.environ.get('BORG_LZ4_PREFIX'):
|
if os.environ.get('BORG_LZ4_PREFIX'):
|
||||||
possible_openssl_prefixes.insert(0, os.environ.get('BORG_LZ4_PREFIX'))
|
possible_lz4_prefixes.insert(0, os.environ.get('BORG_LZ4_PREFIX'))
|
||||||
lz4_prefix = detect_lz4(possible_lz4_prefixes)
|
lz4_prefix = detect_lz4(possible_lz4_prefixes)
|
||||||
if lz4_prefix:
|
if lz4_prefix:
|
||||||
include_dirs.append(os.path.join(lz4_prefix, 'include'))
|
include_dirs.append(os.path.join(lz4_prefix, 'include'))
|
||||||
|
@ -184,12 +184,13 @@ def run(self):
|
||||||
print("auto-generating API documentation")
|
print("auto-generating API documentation")
|
||||||
with open("docs/api.rst", "w") as doc:
|
with open("docs/api.rst", "w") as doc:
|
||||||
doc.write("""
|
doc.write("""
|
||||||
Borg Backup API documentation"
|
Borg Backup API documentation
|
||||||
=============================
|
=============================
|
||||||
""")
|
""")
|
||||||
for mod in glob('borg/*.py') + glob('borg/*.pyx'):
|
for mod in glob('borg/*.py') + glob('borg/*.pyx'):
|
||||||
print("examining module %s" % mod)
|
print("examining module %s" % mod)
|
||||||
if "/_" not in mod:
|
mod = mod.replace('.pyx', '').replace('.py', '').replace('/', '.')
|
||||||
|
if "._" not in mod:
|
||||||
doc.write("""
|
doc.write("""
|
||||||
.. automodule:: %s
|
.. automodule:: %s
|
||||||
:members:
|
:members:
|
||||||
|
@ -255,7 +256,7 @@ def run(self):
|
||||||
},
|
},
|
||||||
author='The Borg Collective (see AUTHORS file)',
|
author='The Borg Collective (see AUTHORS file)',
|
||||||
author_email='borgbackup@librelist.com',
|
author_email='borgbackup@librelist.com',
|
||||||
url='https://borgbackup.github.io/',
|
url='https://borgbackup.readthedocs.org/',
|
||||||
description='Deduplicated, encrypted, authenticated and compressed backups',
|
description='Deduplicated, encrypted, authenticated and compressed backups',
|
||||||
long_description=long_description,
|
long_description=long_description,
|
||||||
license='BSD',
|
license='BSD',
|
||||||
|
|
Loading…
Reference in a new issue