wip docu

semiversus · Oct 1, 2018 · c690dc5 · c690dc5
1 parent f23f7ac
commit c690dc5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/broqer/publisher.py b/broqer/publisher.py
@@ -27,7 +27,7 @@ class Publisher():
     * ``.subscribe(subscriber)`` to subscribe for events on this publisher
     * ``.unsubscribe(subscriber)`` to unsubscribe
     * ``.get()`` to get the current state (will raise ValueError if not
-        stateful)
+      stateful)
 
     When implementing a Publisher use the following methods:
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -7,6 +7,7 @@
 copyright = u'2018, Günther Jena'
 author = u'Günther Jena'
 version = '0.9.0'
+github_url = 'https://github.com/semiversus/python-broqer'
 
 extensions = [
     'sphinx.ext.autodoc',
@@ -21,6 +22,15 @@
 html_theme = 'sphinx_rtd_theme'
 htmlhelp_basename = 'broqer'
 
+html_context = {
+  "display_github": True, # Add 'Edit on Github' link instead of 'View page source'
+  "github_user": "semiversus",
+  "github_repo": project,
+  "github_version": "master",
+  "conf_py_path": "/docs/",
+  "source_suffix": source_suffix,
+}
+
 latex_documents = [
     (master_doc, 'python-broqer.tex', 'python-broqer Documentation',
      u'Günther Jena', 'manual'),