tuning doc

bonobo/__init__.py

@@ -0,0 +1,4 @@
+__title__ = 'bonobo'
+__version__ = '0.0.0'
+__author__ = 'Romain Dorgueil'
+__license__ = 'Apache 2.0'

doc/_templates/sidebarinfos.html

@@ -0,0 +1,10 @@
+<h3>Stay Informed</h3>
+
+<p><a href="http://eepurl.com/csHFKL" target="_blank">Join announcements list</a>.</p>
+
+<p><a href="https://twitter.com/rdorgueil" class="twitter-follow-button" data-show-count="false">Follow @rdorgueil</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script></p>
+
+<p>
+    <iframe src="http://ghbtns.com/github-btn.html?user=python-bonobo&repo=bonobo&type=watch&count=true&size=small"
+            allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+</p>

doc/_templates/sidebarlogo.html

@@ -0,0 +1,10 @@
+<p class="logo">
+    <a href="{{ pathto(master_doc) }}">
+        <img class="logo" src="{{ pathto('_static/bonobo.png', 1) }}" title="Bonobo"/>
+        <h1 style="text-align: center; margin-top: -16px;">Bonobo</h1>
+    </a>
+</p>
+
+<p>
+    Bonobo is ... blablabla
+</p>

doc/conf.py

@@ -1,6 +1,15 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('_themes'))
+
+import bonobo
+from bonobo import __version__
+
 # -- General configuration ------------------------------------------------
 
 extensions = [
@@ -35,9 +44,9 @@ author = 'Romain Dorgueil'
 # built documents.
 #
 # The short X.Y version.
-version = ''
+version = __version__
 # The full version, including alpha/beta/rc tags.
-release = ''
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -57,7 +66,6 @@ pygments_style = 'sphinx'
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
-
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -68,20 +76,24 @@ html_theme = 'alabaster'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#
-# html_theme_options = {}
+html_theme_options = {
+    'github_user': 'python-bonobo',
+    'github_repo': 'bonobo',
+    'github_button': True,
+    'show_powered_by': False,
+    'show_related': True,
+}
+
+html_sidebars = {
+    '**': [
+        'sidebarlogo.html', 'localtoc.html', 'relations.html', 'searchbox.html', 'sidebarinfos.html', 'sourcelink.html',
+    ]
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-
-html_theme_options = {
-    'logo': 'logo.png',
-    'github_user': 'python-bonobo',
-    'github_repo': 'bonobo',
-}
-
 html_show_sphinx = False
 
 # -- Options for HTMLHelp output ------------------------------------------
@@ -89,7 +101,6 @@ html_show_sphinx = False
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Bonobodoc'
 
-
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
@@ -118,7 +129,6 @@ latex_documents = [
      'Romain Dorgueil', 'manual'),
 ]
 
-
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
@@ -128,7 +138,6 @@ man_pages = [
      [author], 1)
 ]
 
-
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
@@ -140,8 +149,6 @@ texinfo_documents = [
      'Miscellaneous'),
 ]
 
-
-
 # -- Options for Epub output ----------------------------------------------
 
 # Bibliographic Dublin Core info.
@@ -162,7 +169,5 @@ epub_copyright = copyright
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ['search.html']
 
-
-
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}

doc/index.rst

@@ -1,20 +1,11 @@
-.. Bonobo documentation master file, created by
-   sphinx-quickstart on Fri Dec  9 06:12:38 2016.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to Bonobo's documentation!
-==================================
+Bonobo
+======
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
 
-
-Indices and tables
-==================
-
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`