|
| 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/master/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 | +# import os |
| 16 | +# import sys |
| 17 | +# sys.path.insert(0, os.path.abspath('.')) |
| 18 | + |
| 19 | +import os |
| 20 | +import sys |
| 21 | + |
| 22 | +sys.path.insert(0, os.path.abspath("../..")) |
| 23 | + |
| 24 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
| 25 | + |
| 26 | +# -- Project information ----------------------------------------------------- |
| 27 | + |
| 28 | +project = "pandoc-code-block-include" |
| 29 | +copyright = "2018-2023, Christophe Demko" |
| 30 | +author = "Christophe Demko" |
| 31 | + |
| 32 | +# The short X.Y version |
| 33 | +version = "1.0" |
| 34 | +# The full version, including alpha/beta/rc tags |
| 35 | +release = "1.0.0" |
| 36 | + |
| 37 | + |
| 38 | +# -- General configuration --------------------------------------------------- |
| 39 | + |
| 40 | +# If your documentation needs a minimal Sphinx version, state it here. |
| 41 | +# |
| 42 | +# needs_sphinx = '1.0' |
| 43 | +needs_sphinx = "6.0" |
| 44 | + |
| 45 | +# Add any Sphinx extension module names here, as strings. They can be |
| 46 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 47 | +# ones. |
| 48 | +extensions = [ |
| 49 | + 'myst_parser' |
| 50 | +] |
| 51 | + |
| 52 | +# Add any paths that contain templates here, relative to this directory. |
| 53 | +templates_path = [] |
| 54 | + |
| 55 | +# The suffix(es) of source filenames. |
| 56 | +# You can specify multiple suffix as a list of string: |
| 57 | +# |
| 58 | +# source_suffix = ['.rst', '.md'] |
| 59 | +source_suffix = { |
| 60 | + '.rst': 'restructuredtext', |
| 61 | + '.md': 'markdown', |
| 62 | +} |
| 63 | + |
| 64 | + |
| 65 | +# The master toctree document. |
| 66 | +master_doc = "index" |
| 67 | + |
| 68 | +# The language for content autogenerated by Sphinx. Refer to documentation |
| 69 | +# for a list of supported languages. |
| 70 | +# |
| 71 | +# This is also used if you do content translation via gettext catalogs. |
| 72 | +# Usually you set "language" from the command line for these cases. |
| 73 | +language = "en" |
| 74 | + |
| 75 | +# List of patterns, relative to source directory, that match files and |
| 76 | +# directories to ignore when looking for source files. |
| 77 | +# This pattern also affects html_static_path and html_extra_path. |
| 78 | +exclude_patterns = ['images'] |
| 79 | + |
| 80 | +# The name of the Pygments (syntax highlighting) style to use. |
| 81 | +# pygments_style = None |
| 82 | +pygments_style = "sphinx" |
| 83 | + |
| 84 | + |
| 85 | +# -- Options for HTML output ------------------------------------------------- |
| 86 | + |
| 87 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 88 | +# a list of builtin themes. |
| 89 | +# |
| 90 | +if not on_rtd: # only import and set the theme if we're building docs locally |
| 91 | + import sphinx_rtd_theme |
| 92 | + |
| 93 | + html_theme = "sphinx_rtd_theme" |
| 94 | + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
| 95 | + |
| 96 | +# Theme options are theme-specific and customize the look and feel of a theme |
| 97 | +# further. For a list of options available for each theme, see the |
| 98 | +# documentation. |
| 99 | +# |
| 100 | +# html_theme_options = {} |
| 101 | + |
| 102 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 103 | +# relative to this directory. They are copied after the builtin static files, |
| 104 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 105 | +html_static_path = [] |
| 106 | + |
| 107 | +# Custom sidebar templates, must be a dictionary that maps document names |
| 108 | +# to template names. |
| 109 | +# |
| 110 | +# The default sidebars (for documents that don't match any pattern) are |
| 111 | +# defined by theme itself. Builtin themes are using these templates by |
| 112 | +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', |
| 113 | +# 'searchbox.html']``. |
| 114 | +# |
| 115 | +# html_sidebars = {} |
| 116 | + |
0 commit comments