[Pkg-privacy-commits] [onionbalance] 23/117: Add buttons for build and docs status

[Donncha O'Cearbahill]

This is an automated email from the git hooks/post-receive script.

donncha-guest pushed a commit to branch debian/sid
in repository onionbalance.

commit 9fed88dba7b5586f745845fbfc3bebba22ec3ae5
Author: Donncha O'Cearbhaill <donncha at donncha.is>
Date:   Wed Jun 17 16:02:09 2015 +0100

    Add buttons for build and docs status
---
 README.rst   | 25 +++++++++++++++++--------
 docs/conf.py | 11 ++++++++++-
 2 files changed, 27 insertions(+), 9 deletions(-)

diff --git a/README.rst b/README.rst
index 5a2b039..8a28ac6 100644
--- a/README.rst
+++ b/README.rst
@@ -6,15 +6,14 @@
 Overview
 --------
 
-The onion service load balancer allows an operator to distribute
-requests for their onion service to between 1 and 10 separate Tor
-instances. Each Tor instance can run completely independently with no
-knowledge of any other instances.
+The OnionBalance software allows the distribution of requests for an onion service to between 1 and 10 separate Tor instances. Each Tor instance can run
+independently with no knowledge of the other instances.
 
-The load balancer is the only system which needs to store the onion
-services's private key. As the load balancer handles no hidden service
-traffic it's risk of deanonymisation by traffic analysis attacks is
-reduced.
+* `Documentation <https://onionbalance.readthedocs.org>`_
+* `Code <https://github.com/DonnchaC/onionbalance/>`_
+* `Bug Tracker <https://github.com/DonnchaC/onionbalance/issues>`_
+
+|build-status| |docs|
 
 Installation
 ------------
@@ -90,3 +89,13 @@ Once your load balancing instances are running, you can start the management ser
 ::
 
     $ onionbalance -c config.yaml
+
+.. |build-status| image:: https://img.shields.io/travis/DonnchaC/onionbalance.svg?style=flat
+    :alt: build status
+    :scale: 100%
+    :target: https://travis-ci.org/DonnchaC/onionbalance
+
+.. |docs| image:: https://readthedocs.org/projects/onionbalance/badge/?version=latest
+    :alt: Documentation Status
+    :scale: 100%
+    :target: https://readthedocs.org/projects/onionbalance/?badge=latest
diff --git a/docs/conf.py b/docs/conf.py
index 3521c29..de4d8a3 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,8 +17,10 @@ import sys
 import os
 import datetime
 
+import sphinx.environment
+from docutils.utils import get_source_line
+
 from onionbalance import __version__, __author__, __contact__
-import onionbalance
 
 # Ignore the 'dev' version suffix.
 if __version__.endswith('dev'):
@@ -32,6 +34,13 @@ sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
+
+# Don't give warning for external images
+def _warn_node(self, msg, node):
+    if not msg.startswith('nonlocal image URI found:'):
+        self._warnfunc(msg, '%s:%s' % get_source_line(node))
+sphinx.environment.BuildEnvironment.warn_node = _warn_node
+
 # If your documentation needs a minimal Sphinx version, state it here.
 needs_sphinx = '1.1'
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/onionbalance.git