add more docs stuff

thundergolfer · Apr 23, 2018 · d189950 · d189950
1 parent cd25ed4
commit d189950
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 3 deletions.
diff --git a/docs/_static/politifact-py-logo.jpg b/docs/_static/politifact-py-logo.jpg
diff --git a/docs/_templates/useful-links.html b/docs/_templates/useful-links.html
@@ -0,0 +1,6 @@
+<h3>Useful Links</h3>
+<ul>
+  {% for text, uri in theme_extra_nav_links.items() %}
+    <li><a href="{{uri}}">{{text}}</a></li>
+  {% endfor %}
+</ul>
diff --git a/docs/conf.py b/docs/conf.py
@@ -15,7 +15,7 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+from collections import OrderedDict
 
 # -- Project information -----------------------------------------------------
 
@@ -44,6 +44,8 @@
     'sphinx.ext.todo',
 ]
 
+issues_github_path = 'thundergolfer/politifact-py'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -83,7 +85,33 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'logo': 'politifact-py-logo.png',
+    'description': 'REST API Wrapper for the Politifact Organisation\'s public API.',
+    'description_font_style': 'italic',
+    'github_user': 'thundergolfer',
+    'github_repo': 'politifact-py',
+    'github_banner': True,
+    'github_type': 'star',
+    'donate_url': 'paypal.me/JonathonBelotti',
+    'code_font_size': '0.8em',
+    'warn_bg': '#FFC',
+    'warn_border': '#EEE',
+    # Used to populate the useful-links.html template
+    'extra_nav_links': OrderedDict([
+        ('politifact-py @ PyPI', 'https://pypi.org/project/politifact/'),
+        ('politifact-py @ GitHub', 'http://github.com/thundergolfer/politifact-py'),
+        ('Issue Tracker', 'http://github.com/thundergolfer/politifact-py/issues'),
+    ])
+}
+
+html_sidebars = {
+    'index': [
+        'about.html', 'useful-links.html', 'searchbox.html',
+    ],
+    '**': ['about.html', 'useful-links.html',
+           'localtoc.html', 'relations.html', 'searchbox.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,
@@ -163,4 +191,4 @@
 # -- Options for todo extension ----------------------------------------------
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
+todo_include_todos = True