|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# -*- coding: utf-8 -*- |
| 3 | +import sphinx_rtd_theme |
| 4 | + |
| 5 | +# -- General configuration ------------------------------------------------ |
| 6 | + |
| 7 | +# If your documentation needs a minimal Sphinx version, state it here. |
| 8 | +# |
| 9 | +# needs_sphinx = '1.0' |
| 10 | + |
| 11 | +# Add any Sphinx extension module names here, as strings. They can be |
| 12 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 13 | +# ones. |
| 14 | +extensions = ['sphinx.ext.mathjax'] # 'breathe' |
| 15 | + |
| 16 | +# Add any paths that contain templates here, relative to this directory. |
| 17 | +templates_path = ['@PROJECT_SOURCE_DIR@/docs/_templates'] |
| 18 | + |
| 19 | +# The suffix(es) of source filenames. |
| 20 | +# You can specify multiple suffix as a list of string: |
| 21 | +# |
| 22 | +# source_suffix = ['.rst', '.md'] |
| 23 | +source_suffix = '.rst' |
| 24 | + |
| 25 | +# The master toctree document. |
| 26 | +master_doc = 'index' |
| 27 | + |
| 28 | +# General information about the project. |
| 29 | +project = '@PROJECT_NAME@' |
| 30 | +copyright = '2017, Morris Hafner' |
| 31 | +author = 'Morris Hafner' |
| 32 | + |
| 33 | +breathe_projects = { "@PROJECT_NAME@": "@PROJECT_BINARY_DIR@/doxy/xml" } |
| 34 | +breathe_default_project = "@PROJECT_NAME@" |
| 35 | + |
| 36 | +# The version info for the project you're documenting, acts as replacement for |
| 37 | +# |version| and |release|, also used in various other places throughout the |
| 38 | +# built documents. |
| 39 | +# |
| 40 | +# The short X.Y version. |
| 41 | +version = '@PROJECT_VERSION@' |
| 42 | +# The full version, including alpha/beta/rc tags. |
| 43 | +release = '@PROJECT_VERSION@' |
| 44 | + |
| 45 | +# The language for content autogenerated by Sphinx. Refer to documentation |
| 46 | +# for a list of supported languages. |
| 47 | +# |
| 48 | +# This is also used if you do content translation via gettext catalogs. |
| 49 | +# Usually you set "language" from the command line for these cases. |
| 50 | +language = None |
| 51 | + |
| 52 | +# List of patterns, relative to source directory, that match files and |
| 53 | +# directories to ignore when looking for source files. |
| 54 | +# This patterns also effect to html_static_path and html_extra_path |
| 55 | +exclude_patterns = [] |
| 56 | + |
| 57 | +# The name of the Pygments (syntax highlighting) style to use. |
| 58 | +pygments_style = 'sphinx' |
| 59 | + |
| 60 | +# If true, `todo` and `todoList` produce output, else they produce nothing. |
| 61 | +todo_include_todos = False |
| 62 | + |
| 63 | + |
| 64 | +# -- Options for HTML output ---------------------------------------------- |
| 65 | + |
| 66 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 67 | +# a list of builtin themes. |
| 68 | +# |
| 69 | +html_theme = 'sphinx_rtd_theme' |
| 70 | +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
| 71 | + |
| 72 | +# Theme options are theme-specific and customize the look and feel of a theme |
| 73 | +# further. For a list of options available for each theme, see the |
| 74 | +# documentation. |
| 75 | +# |
| 76 | +# html_theme_options = {} |
| 77 | + |
| 78 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 79 | +# relative to this directory. They are copied after the builtin static files, |
| 80 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 81 | +html_static_path = ['@PROJECT_SOURCE_DIR@/docs/_static'] |
| 82 | + |
| 83 | + |
| 84 | +# -- Options for HTMLHelp output ------------------------------------------ |
| 85 | + |
| 86 | +# Output file base name for HTML help builder. |
| 87 | +htmlhelp_basename = '@PROJECT_NAME@doc' |
0 commit comments