This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
devicehub-teal/docs/conf.py

176 lines
5.4 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
#
2018-06-10 16:47:49 +00:00
# Configuration file for the Sphinx documentation builder.
#
2018-06-10 16:47:49 +00:00
# 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/master/config
2018-06-10 16:47:49 +00:00
# -- 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.
2018-06-10 16:47:49 +00:00
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'Devicehub'
copyright = '2018, eReuse.org team'
author = 'eReuse.org team'
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '0.1'
2018-06-10 16:47:49 +00:00
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
2018-06-10 16:47:49 +00:00
#
# 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.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
2018-06-19 20:49:42 +00:00
'sphinxcontrib.plantuml',
'sphinx.ext.autosectionlabel'
]
# 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:
2018-06-10 16:47:49 +00:00
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
2018-06-10 16:47:49 +00:00
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
2018-06-10 16:47:49 +00:00
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
2018-06-10 16:47:49 +00:00
#
html_theme = 'alabaster'
# 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.
2018-06-10 16:47:49 +00:00
#
# html_theme_options = {}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
2018-06-10 16:47:49 +00:00
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
2018-06-10 16:47:49 +00:00
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
2018-06-10 16:47:49 +00:00
htmlhelp_basename = 'Devicehubdoc'
2018-06-10 16:47:49 +00:00
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
2018-06-10 16:47:49 +00:00
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
2018-06-10 16:47:49 +00:00
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
2018-06-10 16:47:49 +00:00
#
# 'preamble': '',
# Latex figure (float) alignment
2018-06-10 16:47:49 +00:00
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
2018-06-10 16:47:49 +00:00
(master_doc, 'Devicehub.tex', 'Devicehub Documentation',
'eReuse.org team', 'manual'),
]
2018-06-10 16:47:49 +00:00
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
2018-06-10 16:47:49 +00:00
(master_doc, 'devicehub', 'Devicehub Documentation',
[author], 1)
]
2018-06-10 16:47:49 +00:00
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
2018-06-10 16:47:49 +00:00
(master_doc, 'Devicehub', 'Devicehub Documentation',
author, 'Devicehub', 'One line description of project.',
'Miscellaneous'),
]
2018-06-10 16:47:49 +00:00
# -- Extension configuration -------------------------------------------------
2018-06-10 16:47:49 +00:00
# -- Options for intersphinx extension ---------------------------------------
2018-06-10 16:47:49 +00:00
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
2018-06-10 16:47:49 +00:00
# -- Options for todo extension ----------------------------------------------
2018-06-10 16:47:49 +00:00
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
2018-06-10 16:47:49 +00:00
# Plantuml
plantuml_output_format = 'svg'
2018-06-10 16:47:49 +00:00
# favicon
html_favicon = 'img/favicon.ico'
2018-06-19 20:49:42 +00:00
# autosectionlabel
autosectionlabel_prefix_document = True