From ff04a654ab69f6c239b9a04e96b0ad66c5ca294a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Fri, 9 Oct 2015 14:25:29 -0400 Subject: [PATCH 1/4] remove trailing quote --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f2a3f8bb9..d19004efc 100644 --- a/setup.py +++ b/setup.py @@ -184,7 +184,7 @@ class build_api(Command): print("auto-generating API documentation") with open("docs/api.rst", "w") as doc: doc.write(""" -Borg Backup API documentation" +Borg Backup API documentation ============================= """) for mod in glob('borg/*.py') + glob('borg/*.pyx'): From 2f9bdfe96b570b650f2f7cb8942582d5c2c90b67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Fri, 9 Oct 2015 14:29:16 -0400 Subject: [PATCH 2/4] fix API generation properly generate the module name --- setup.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index d19004efc..d899694b9 100644 --- a/setup.py +++ b/setup.py @@ -189,7 +189,8 @@ Borg Backup API documentation """) for mod in glob('borg/*.py') + glob('borg/*.pyx'): print("examining module %s" % mod) - if "/_" not in mod: + mod = mod.replace('.pyx', '').replace('.py', '').replace('/', '.') + if "._" not in mod: doc.write(""" .. automodule:: %s :members: From da2ec7995fe9793f371bcc1f08c5b7d00a485062 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Fri, 9 Oct 2015 15:54:02 -0400 Subject: [PATCH 3/4] fix homepage URL in all remaining places we update the documentation to mention the automatic updates, and also remove the hack in the makefile to update the github.io pages, which are gone. --- README.rst | 8 ++++---- docs/Makefile | 11 ----------- docs/development.rst | 6 ++---- setup.py | 2 +- 4 files changed, 7 insertions(+), 20 deletions(-) diff --git a/README.rst b/README.rst index a43375491..54e069ae4 100644 --- a/README.rst +++ b/README.rst @@ -12,7 +12,7 @@ fully trusted targets. See the `installation manual`_ or, if you have already 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 ~~~~~~~~~~~~~ @@ -112,7 +112,7 @@ Notes 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 `_ about the initial considerations regarding project goals and policy of the Borg project. @@ -123,7 +123,7 @@ 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 information. -.. _changelog: https://borgbackup.github.io/borgbackup/changes.html +.. _changelog: https://borgbackup.readthedocs.org/changes.html NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES. @@ -132,7 +132,7 @@ THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS. Borg is distributed under a 3-clause BSD license, see `the license`_ for the complete license. -.. _the license: https://borgbackup.github.io/borgbackup/authors.html#license +.. _the license: https://borgbackup.readthedocs.org/authors.html#license |build| |coverage| diff --git a/docs/Makefile b/docs/Makefile index fb470c6a9..09be16fcb 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -128,14 +128,3 @@ doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "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 diff --git a/docs/development.rst b/docs/development.rst index b2fe34aaf..cce5cb5d3 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -68,10 +68,8 @@ Now run:: 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 -`_build` directory to the `borgbackup` directory in the web site's repository: -https://github.com/borgbackup/borgbackup.github.io - +The website is updated automatically through Github web hooks on the +main repository. Using Vagrant ------------- diff --git a/setup.py b/setup.py index d899694b9..2c9c37241 100644 --- a/setup.py +++ b/setup.py @@ -256,7 +256,7 @@ setup( }, author='The Borg Collective (see AUTHORS file)', author_email='borgbackup@librelist.com', - url='https://borgbackup.github.io/', + url='https://borgbackup.readthedocs.org/', description='Deduplicated, encrypted, authenticated and compressed backups', long_description=long_description, license='BSD', From 8eaf460da346d8aa5c4b43dbac704d7b7dd76377 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sun, 11 Oct 2015 21:20:29 +0200 Subject: [PATCH 4/4] setup.py: fix bug related to BORG_LZ4_PREFIX processing --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f2a3f8bb9..3ebf728a9 100644 --- a/setup.py +++ b/setup.py @@ -111,7 +111,7 @@ library_dirs.append(os.path.join(ssl_prefix, 'lib')) 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'): - 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) if lz4_prefix: include_dirs.append(os.path.join(lz4_prefix, 'include'))