|
| 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 datetime |
| 14 | +import os |
| 15 | +import sys |
| 16 | +sys.path.insert(0, os.path.abspath("../../src")) |
| 17 | + |
| 18 | + |
| 19 | +# -- Project information ----------------------------------------------------- |
| 20 | + |
| 21 | +project = 'imslp' |
| 22 | +copyright = "2020–{}, Jérémie Lumbroso".format(datetime.datetime.now().year).replace("2020–2020", "2020") |
| 23 | +author = "Jérémie Lumbroso" |
| 24 | + |
| 25 | +# The short X.Y version. |
| 26 | +try: |
| 27 | + import imslp |
| 28 | + version = '.'.join(map(str, imslp.version_info[:2])) |
| 29 | + release = imslp.__version__ |
| 30 | +except ImportError: |
| 31 | + version = '' |
| 32 | + release = '' |
| 33 | + |
| 34 | + |
| 35 | +# -- General configuration --------------------------------------------------- |
| 36 | + |
| 37 | +# Add any Sphinx extension module names here, as strings. They can be |
| 38 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 39 | +# ones. |
| 40 | +extensions = [ |
| 41 | + "sphinx_rtd_theme", |
| 42 | + "sphinx.ext.autodoc", |
| 43 | + "sphinx.ext.autodoc.typehints", |
| 44 | + "sphinx.ext.coverage", |
| 45 | + "sphinx.ext.napoleon", |
| 46 | +] |
| 47 | + |
| 48 | +# Add any paths that contain templates here, relative to this directory. |
| 49 | +templates_path = ["_templates"] |
| 50 | + |
| 51 | +# List of patterns, relative to source directory, that match files and |
| 52 | +# directories to ignore when looking for source files. |
| 53 | +# This pattern also affects html_static_path and html_extra_path. |
| 54 | +exclude_patterns = [] |
| 55 | + |
| 56 | +# Autodoc Type Hints turned on (beta in 2.4, core in 3.x) |
| 57 | +autodoc_typehints = "description" |
| 58 | + |
| 59 | + |
| 60 | +# -- Options for HTML output ------------------------------------------------- |
| 61 | + |
| 62 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 63 | +# a list of builtin themes. |
| 64 | +# |
| 65 | +html_theme = "sphinx_rtd_theme" |
| 66 | + |
| 67 | +# See https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html |
| 68 | +html_theme_options = { |
| 69 | + "style_nav_header_background": "#604D61", |
| 70 | +} |
| 71 | + |
| 72 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 73 | +# relative to this directory. They are copied after the builtin static files, |
| 74 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 75 | +html_static_path = ["_static"] |
0 commit comments