conf.py

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config

# -- Path setup --------------------------------------------------------------

# 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.

import os
import sys
sys.path.append(os.path.abspath('.extensions'))
sys.path.append(os.path.abspath('.extensions/sphinx-polyglot'))

import sphinx_bootstrap_theme

# -- Project information -----------------------------------------------------

project = 'DRYlib'
author  = 'Arto Bendiken'
version = '2018-07-19'
release = version

# -- General configuration ---------------------------------------------------

needs_sphinx = '1.7'
extensions = [
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
    'sphinxcontrib.toc',
    'sphinx-polyglot', # file:.extensions/sphinx-polyglot/sphinx-polyglot.py
    'sphinx-dry',      # file:.extensions/sphinx-dry.py
]
templates_path = ['.templates']
source_suffix = '.rst'
master_doc = 'index'
language = 'en'
locale_dirs = ['.locales']
exclude_patterns = ['.build', '.extensions', '.themes', 'CHANGES.rst', 'CREDITS.rst', 'README.rst', 'TODO.rst']
pygments_style = 'sphinx'

# -- Options for HTML output -------------------------------------------------

html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
html_theme_options = {
    'navbar_title': project,
    'navbar_site_name': 'TOC',
    'navbar_links': [],
    'navbar_sidebarrel': True,
    'navbar_pagenav': False,
    'navbar_pagenav_name': 'Page',
    'globaltoc_depth': 1,
    'globaltoc_includehidden': True,
    'navbar_class': 'navbar navbar-inverse',
    'navbar_fixed_top': True,
    'source_link_position': None,
    #'bootswatch_theme': None,
    'bootstrap_version': '3',
}
html_logo = '.static/logo.png'
html_favicon = '.static/icon.png'
html_static_path = ['.static']
html_extra_path = ['.htdocs']
#html_sidebars = {}
html_show_copyright = False
html_show_sphinx = False
html_last_updated_fmt = '%Y-%m-%d'

#html_sidebars = {
#   '**': ['searchbox.html', 'globaltoc.html', 'localtoc.html', 'relations.html', 'sourcelink.html'],
#}

# -- Options for HTMLHelp output ---------------------------------------------

htmlhelp_basename = 'drylib'

# -- Options for LaTeX output ------------------------------------------------

latex_engine = 'xelatex'

latex_elements = {
    'papersize': 'a4paper',
    #'pointsize': '10pt', # ('10pt', '11pt' or '12pt').
    #'preamble': '',
    #'figure_align': 'htbp',
}

latex_documents = [
    (master_doc, 'drylib.tex', "DRYlib Manual", author, 'manual'),
]

# -- Options for manual page output ------------------------------------------

man_pages = [
    (master_doc, 'drylib', project, [author], 1)
]

# -- Options for Texinfo output ----------------------------------------------

texinfo_documents = [
    (master_doc, 'drylib', project,
     author, 'DRYlib', 'One line description of project.',
     'Miscellaneous'),
]

# -- Extension configuration -------------------------------------------------

# -- Options for todo extension ----------------------------------------------

todo_include_todos = True