Add logo to docs

README.rst

@@ -4,6 +4,8 @@
     :target: https://travis-ci.org/mdomke/schwifty
 .. image:: https://img.shields.io/pypi/l/schwifty.svg?style=flat-square
     :target: https://pypi.python.org/pypi/schwifty
+.. image:: https://readthedocs.org/projects/schwifty/badge/?version=latest&style=flat-square
+    :target: https://schwifty.readthedocs.io
 
 
 Gotta get schwifty with your IBANs

docs/source/conf.py

@@ -1,56 +1,28 @@
 # -*- coding: utf-8 -*-
-#
-# Schwifty documentation build configuration file, created by
-# sphinx-quickstart on Fri Mar  4 16:17:00 2016.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
 import sys
 import os
+from datetime import datetime
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../..'))
 
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
 ]
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
+source_suffix = ['.rst', '.md']
 master_doc = 'index'
-
-# General information about the project.
 project = u'Schwifty'
-copyright = u'2020, Martin Domke'
+copyright = u'{0.year} Martin Domke'.format(datetime.now())
 author = u'Martin Domke'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -116,7 +88,12 @@
 # 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': 'mdomke',
+    'github_repo': 'schwifty',
+    'description': 'A library for parsing and validating IBANs and BICs',
+    'sidebar_collapse': False,
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
@@ -130,7 +107,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = 'ilikewhatugot.png'
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -156,7 +133,15 @@
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.

docs/source/index.rst

@@ -1,8 +1,3 @@
-.. Schwifty documentation master file, created by
-   sphinx-quickstart on Fri Mar  4 16:17:00 2016.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Get schwifty with IBANs and BICs
 ================================
 
@@ -25,9 +20,6 @@ Schwifty lets you
 Examples
 --------
 
-.. module:: schwifty
-   :noindex:
-
 
 Basic usage
 ~~~~~~~~~~~