X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Fconf.py;h=d051efa7ae7c0859b03726b22bc26bfedb089453;hb=db35ea171e147ed3d65bdab0e2f14caaf96582f9;hp=0fb2bdd50058f8bd54a8330ff50f10da6756d861;hpb=d39f04d4d8502d1367bfb5070db78df55081800e;p=mpd-sima.git diff --git a/doc/source/conf.py b/doc/source/conf.py index 0fb2bdd..d051efa 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -13,17 +13,11 @@ # All configuration values have a default; values that are commented out # serve to show the default. -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__ +from sima.info import __author__ # -- General configuration ------------------------------------------------ @@ -36,6 +30,7 @@ from sima.info import __version__ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', + 'sphinx.ext.intersphinx', ] # Add any paths that contain templates here, relative to this directory. @@ -54,17 +49,18 @@ master_doc = 'index' # General information about the project. project = 'MPD_sima' -copyright = '2015-2017, 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 = __version__ +#version = # The full version, including alpha/beta/rc tags. -release = __version__ +#release = # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -115,17 +111,19 @@ 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 = 'bootstrap' -#html_theme = 'classic' +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 # documentation. -#html_theme_options = {} +html_theme_options = { + "externalrefs": True, + "sidebarwidth": "300px", + "bgcolor": "#dfdfdf", +} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['/usr/lib/python3/dist-packages/sphinx_bootstrap_theme'] +#html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -261,8 +259,12 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'mpd_sima', 'MPD_sima Documentation', - [author], 1) + ('man/mpd-sima.1', 'mpd-sima', + 'mpd-sima will try to maintain some titles ahead in the queue following different policies.', + [author], 1), + ('man/mpd_sima.cfg.5', 'mpd_sima.cfg', + 'mpd-sima configuration.', + [author], 5), ] # If true, show URL addresses after external links. @@ -291,3 +293,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}