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 3ebf728a9..e2fce2823 100644 --- a/setup.py +++ b/setup.py @@ -184,12 +184,13 @@ def run(self): 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'): 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: @@ -255,7 +256,7 @@ def run(self): }, 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',