| 1 |
# -*- coding: utf-8 -*- |
| 2 |
# |
| 3 |
# Configuration file for the Sphinx documentation builder. |
| 4 |
# |
| 5 |
# This file does only contain a selection of the most common options. For a |
| 6 |
# full list see the documentation: |
| 7 |
# http://www.sphinx-doc.org/en/stable/config |
| 8 |
|
| 9 |
# -- Path setup -------------------------------------------------------------- |
| 10 |
|
| 11 |
# If extensions (or modules to document with autodoc) are in another directory, |
| 12 |
# add these directories to sys.path here. If the directory is relative to the |
| 13 |
# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 14 |
# |
| 15 |
# sys.path.insert(0, os.path.abspath('.')) |
| 16 |
|
| 17 |
import sys |
| 18 |
import os |
| 19 |
sys.path.insert(0, os.path.abspath('@BUILDDIR@')) |
| 20 |
|
| 21 |
# -- Project information ----------------------------------------------------- |
| 22 |
|
| 23 |
project = '@PROJECT_NAME@' |
| 24 |
copyright = '2019, the libinput authors' |
| 25 |
author = 'the libinput authors' |
| 26 |
|
| 27 |
# The short X.Y version |
| 28 |
version = '@PROJECT_VERSION@' |
| 29 |
# The full version, including alpha/beta/rc tags |
| 30 |
release = '@PROJECT_VERSION@' |
| 31 |
|
| 32 |
|
| 33 |
# -- General configuration --------------------------------------------------- |
| 34 |
|
| 35 |
# If your documentation needs a minimal Sphinx version, state it here. |
| 36 |
# |
| 37 |
# needs_sphinx = '1.0' |
| 38 |
|
| 39 |
# Add any Sphinx extension module names here, as strings. They can be |
| 40 |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 41 |
# ones. |
| 42 |
extensions = [ |
| 43 |
'sphinx.ext.mathjax', |
| 44 |
'sphinx.ext.graphviz', |
| 45 |
'sphinx.ext.extlinks', |
| 46 |
] |
| 47 |
|
| 48 |
# Add any paths that contain templates here, relative to this directory. |
| 49 |
templates_path = ['_templates'] |
| 50 |
|
| 51 |
# The suffix(es) of source filenames. |
| 52 |
# You can specify multiple suffix as a list of string: |
| 53 |
# |
| 54 |
# source_suffix = ['.rst', '.md'] |
| 55 |
source_suffix = '.rst' |
| 56 |
|
| 57 |
# The master toctree document. |
| 58 |
master_doc = 'index' |
| 59 |
|
| 60 |
# The language for content autogenerated by Sphinx. Refer to documentation |
| 61 |
# for a list of supported languages. |
| 62 |
# |
| 63 |
# This is also used if you do content translation via gettext catalogs. |
| 64 |
# Usually you set "language" from the command line for these cases. |
| 65 |
language = 'en' |
| 66 |
|
| 67 |
# List of patterns, relative to source directory, that match files and |
| 68 |
# directories to ignore when looking for source files. |
| 69 |
# This pattern also affects html_static_path and html_extra_path . |
| 70 |
exclude_patterns = [] |
| 71 |
|
| 72 |
# The name of the Pygments (syntax highlighting) style to use. |
| 73 |
pygments_style = 'sphinx' |
| 74 |
|
| 75 |
highlight_language = 'none' |
| 76 |
|
| 77 |
# -- Options for HTML output ------------------------------------------------- |
| 78 |
|
| 79 |
# The theme to use for HTML and HTML Help pages. See the documentation for |
| 80 |
# a list of builtin themes. |
| 81 |
# |
| 82 |
html_theme = 'sphinx_rtd_theme' |
| 83 |
|
| 84 |
# Theme options are theme-specific and customize the look and feel of a theme |
| 85 |
# further. For a list of options available for each theme, see the |
| 86 |
# documentation. |
| 87 |
# |
| 88 |
html_theme_options = { |
| 89 |
'collapse_navigation': False, |
| 90 |
'navigation_depth': 3, |
| 91 |
} |
| 92 |
|
| 93 |
# Add any paths that contain custom static files (such as style sheets) here, |
| 94 |
# relative to this directory. They are copied after the builtin static files, |
| 95 |
# so a file named "default.css" will overwrite the builtin "default.css". |
| 96 |
# html_static_path = ['_static'] |
| 97 |
|
| 98 |
# Custom sidebar templates, must be a dictionary that maps document names |
| 99 |
# to template names. |
| 100 |
# |
| 101 |
# The default sidebars (for documents that don't match any pattern) are |
| 102 |
# defined by theme itself. Builtin themes are using these templates by |
| 103 |
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', |
| 104 |
# 'searchbox.html']``. |
| 105 |
# |
| 106 |
# html_sidebars = {} |
| 107 |
|
| 108 |
|
| 109 |
# -- Options for HTMLHelp output --------------------------------------------- |
| 110 |
|
| 111 |
# Output file base name for HTML help builder. |
| 112 |
htmlhelp_basename = '@PROJECT_NAME@doc' |
| 113 |
|
| 114 |
|
| 115 |
# -- Options for LaTeX output ------------------------------------------------ |
| 116 |
|
| 117 |
latex_elements = { |
| 118 |
# The paper size ('letterpaper' or 'a4paper'). |
| 119 |
# |
| 120 |
# 'papersize': 'letterpaper', |
| 121 |
|
| 122 |
# The font size ('10pt', '11pt' or '12pt'). |
| 123 |
# |
| 124 |
# 'pointsize': '10pt', |
| 125 |
|
| 126 |
# Additional stuff for the LaTeX preamble. |
| 127 |
# |
| 128 |
# 'preamble': '', |
| 129 |
|
| 130 |
# Latex figure (float) alignment |
| 131 |
# |
| 132 |
# 'figure_align': 'htbp', |
| 133 |
} |
| 134 |
|
| 135 |
# Grouping the document tree into LaTeX files. List of tuples |
| 136 |
# (source start file, target name, title, |
| 137 |
# author, documentclass [howto, manual, or own class]). |
| 138 |
latex_documents = [ |
| 139 |
(master_doc, '@[email protected]', '@PROJECT_NAME@ Documentation', |
| 140 |
'Peter Hutterer', 'manual'), |
| 141 |
] |
| 142 |
|
| 143 |
|
| 144 |
# -- Options for manual page output ------------------------------------------ |
| 145 |
|
| 146 |
# One entry per manual page. List of tuples |
| 147 |
# (source start file, name, description, authors, manual section). |
| 148 |
man_pages = [ |
| 149 |
(master_doc, '@PROJECT_NAME@', '@PROJECT_NAME@ Documentation', |
| 150 |
[author], 1) |
| 151 |
] |
| 152 |
|
| 153 |
|
| 154 |
# -- Options for Texinfo output ---------------------------------------------- |
| 155 |
|
| 156 |
# Grouping the document tree into Texinfo files. List of tuples |
| 157 |
# (source start file, target name, title, author, |
| 158 |
# dir menu entry, description, category) |
| 159 |
texinfo_documents = [ |
| 160 |
(master_doc, '@PROJECT_NAME@', '@PROJECT_NAME@ Documentation', |
| 161 |
author, '@PROJECT_NAME@', 'One line description of project.', |
| 162 |
'Miscellaneous'), |
| 163 |
] |
| 164 |
|
| 165 |
|
| 166 |
# -- Extension configuration ------------------------------------------------- |
| 167 |
|
| 168 |
from recommonmark.parser import CommonMarkParser |
| 169 |
|
| 170 |
extlinks = { 'commit' : |
| 171 |
('https://gitlab.freedesktop.org/libinput/libinput/commit/%s', |
| 172 |
'git commit %s') |
| 173 |
} |
| 174 |
|
| 175 |
# -- git version hack ------------------------------------------------- |
| 176 |
# |
| 177 |
# meson doesn't take configuration_data() for vcs_tag, so we cannot replace |
| 178 |
# two substrings in the same file. |
| 179 |
# |
| 180 |
# sphinx cannot do ..include:: without linebreaks, so in-line replacements |
| 181 |
# are a no-go. |
| 182 |
# |
| 183 |
# Work around this by generating a mini python module in meson through |
| 184 |
# vcs_tag, then use that to generate the replacements in rst_prolog. |
| 185 |
|
| 186 |
import git_version |
| 187 |
|
| 188 |
rst_prolog = """ |
| 189 |
.. |git_version| replace:: :commit:`{}` |
| 190 |
.. |git_version_full| replace:: :commit:`{}` |
| 191 |
|
| 192 |
""".format(git_version.get_git_version(), |
| 193 |
git_version.get_git_version_full) |