doc: Update sphinx config, add user documentation

[mpd-sima.git] / doc / source / conf.py

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 4bbcf8a6585e5ba2212285fd68412e9e2ce030d8..384585515da4f5c61fa82a1505aaf8c8f0d29c53 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -15,13 +15,14 @@
 
 import sys
 import os
-import shlex
+
 
 # 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('.'))
 sys.path.insert(0, os.path.abspath('../../'))
+from sima.info import __version__, __author__
 
 # -- General configuration ------------------------------------------------
 
@@ -34,6 +35,7 @@ sys.path.insert(0, os.path.abspath('../../'))
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'sphinx.ext.intersphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -52,17 +54,18 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'MPD_sima'
-copyright = '2015, kaliko'
-author = 'kaliko'
+from datetime import datetime
+copyright = '2009-{}, {}'.format(datetime.now().year, __author__)
+author = __author__
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.14'
+version = __version__
 # The full version, including alpha/beta/rc tags.
-release = '0.14'
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -113,7 +116,9 @@ todo_include_todos = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
+html_theme = 'bootstrap'
+#html_theme = 'classic'
 
 # 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
@@ -121,7 +126,7 @@ html_theme = 'alabaster'
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = ['/usr/lib/python3/dist-packages/sphinx_bootstrap_theme']
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -287,3 +292,5 @@ texinfo_documents = [
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
+
+intersphinx_mapping = {'https://docs.python.org/': None}