GoulagSort/docs/source/conf.py

56 lines
1.7 KiB
Python

import os
import sys
from recommonmark.transform import AutoStructify
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..')))
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'goulagSort'
copyright = '2025, Gustavo Henrique Santos Souza de Miranda'
author = 'Gustavo Henrique Santos Souza de Miranda'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinx.ext.todo',
'recommonmark',
'sphinxcontrib.mermaid'
]
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_css_files = [
'custom.css',
]
rst_prolog = """
.. role:: bigText
:class: big-text
"""
def setup(app):
app.add_config_value('recommonmark_config', {
'auto_toc_tree_section': 'Contents',
'enable_math': False,
'enable_proxy_refs': False,
'enable_css_classes': True,
'enable_eval_rst': True,
}, True)
app.add_transform(AutoStructify)