Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame] | 1 | # Configuration file for the Sphinx documentation builder. |
| 2 | # |
| 3 | # This file only contains a selection of the most common options. For a full |
| 4 | # list see the documentation: |
| 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 6 | |
| 7 | # -- Path setup -------------------------------------------------------------- |
| 8 | |
| 9 | # If extensions (or modules to document with autodoc) are in another directory, |
| 10 | # add these directories to sys.path here. If the directory is relative to the |
| 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
| 12 | # |
| 13 | import os |
| 14 | import sys |
| 15 | sys.path.insert(0, os.path.abspath('..')) |
| 16 | |
| 17 | |
| 18 | # -- Project information ----------------------------------------------------- |
| 19 | |
Harald Welte | 348c195 | 2021-04-11 10:58:14 +0200 | [diff] [blame] | 20 | project = 'osmopysim-usermanual' |
Harald Welte | 12af793 | 2022-02-15 16:39:08 +0100 | [diff] [blame] | 21 | copyright = '2009-2022 by Sylvain Munaut, Harald Welte, Philipp Maier, Supreeth Herle' |
Harald Welte | b29df88 | 2021-04-03 11:29:31 +0200 | [diff] [blame] | 22 | author = 'Sylvain Munaut, Harald Welte, Philipp Maier, Supreeth Herle' |
Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame] | 23 | |
| 24 | |
| 25 | # -- General configuration --------------------------------------------------- |
| 26 | |
| 27 | # Add any Sphinx extension module names here, as strings. They can be |
| 28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 29 | # ones. |
| 30 | extensions = [ |
| 31 | "sphinx.ext.autodoc", |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 32 | "sphinxarg.ext", |
Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame] | 33 | "sphinx.ext.autosectionlabel", |
| 34 | "sphinx.ext.napoleon" |
| 35 | ] |
| 36 | |
| 37 | # Add any paths that contain templates here, relative to this directory. |
| 38 | templates_path = ['_templates'] |
| 39 | |
| 40 | # List of patterns, relative to source directory, that match files and |
| 41 | # directories to ignore when looking for source files. |
| 42 | # This pattern also affects html_static_path and html_extra_path. |
| 43 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 44 | |
| 45 | |
| 46 | # -- Options for HTML output ------------------------------------------------- |
| 47 | |
| 48 | # The theme to use for HTML and HTML Help pages. See the documentation for |
| 49 | # a list of builtin themes. |
| 50 | # |
| 51 | html_theme = 'alabaster' |
| 52 | |
| 53 | # Add any paths that contain custom static files (such as style sheets) here, |
| 54 | # relative to this directory. They are copied after the builtin static files, |
| 55 | # so a file named "default.css" will overwrite the builtin "default.css". |
| 56 | html_static_path = ['_static'] |
| 57 | |
| 58 | autoclass_content = 'both' |