idrlnet/docs/conf.py

# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys

sys.path.insert(0, os.path.abspath(".."))

# -- Project information -----------------------------------------------------

project = "idrlnet"
copyright = "2023, IDRL"
author = "IDRL"

# The full version, including alpha/beta/rc tags
release = "2.0.0-rc3"

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.mathjax",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "myst_parser",
    "sphinx.ext.autosectionlabel",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

source_suffix = {
    ".rst": "restructuredtext",
    ".txt": "markdown",
    ".md": "markdown",
}
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

# for MarkdownParser
from sphinx_markdown_parser.parser import MarkdownParser  # noqa


# def setup(app):
#     # app.add_source_suffix('.md', 'markdown')
#     # app.add_source_parser(MarkdownParser)
#     app.add_config_value('markdown_parser_config', {
#         'auto_toc_tree_section': 'Content',
#         'enable_auto_doc_ref': True,
#         'enable_auto_toc_tree': True,
#         'enable_eval_rst': True,
#         'extensions': [
#             'extra',
#             'nl2br',
#             'sane_lists',
#             'smarty',
#             'toc',
#             'wikilinks',
#             'pymdownx.arithmatex',
#         ],
#     }, True)