X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Fconf.py;h=d4040d07fe8b08b6406584bdb7f51586b76cb245;hb=e4f642e20348dab3523316157dafdd609fa32455;hp=4bbcf8a6585e5ba2212285fd68412e9e2ce030d8;hpb=7a017681a7646e8f8a3d7226b4ae9e1f6d7dbf41;p=mpd-sima.git diff --git a/doc/source/conf.py b/doc/source/conf.py index 4bbcf8a..d4040d0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -13,15 +13,14 @@ # 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('.')) +import os +import sys sys.path.insert(0, os.path.abspath('../../')) +from sima.info import __author__ # -- General configuration ------------------------------------------------ @@ -34,6 +33,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 +52,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 = # The full version, including alpha/beta/rc tags. -release = '0.14' +#release = # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -113,12 +114,16 @@ 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 = '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 = [] @@ -257,8 +262,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. @@ -287,3 +296,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}