good starting point for docs
This commit is contained in:
48
docs/src/conf.py
Normal file
48
docs/src/conf.py
Normal file
@@ -0,0 +1,48 @@
|
||||
# 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
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
project = 'rlp'
|
||||
copyright = '2023, madeleine sydney ślaga'
|
||||
author = 'madeleine sydney slaga'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = ['sphinx.ext.imgmath']
|
||||
|
||||
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 = 'alabaster'
|
||||
html_static_path = ['_static']
|
||||
|
||||
# -- Options for LaTeX image math --------------------------------------------
|
||||
imgmath_latex_preamble = r'''
|
||||
\usepackage{amsmath}
|
||||
\usepackage{tabularray}
|
||||
|
||||
\newcommand{\transrule}[2]
|
||||
{\begin{tblr}{|ccclc|}
|
||||
\hline
|
||||
& #1 \\
|
||||
\implies & #2 \\
|
||||
\hline
|
||||
\end{tblr} }
|
||||
'''
|
||||
imgmath_image_format = 'svg'
|
||||
imgmath_font_size = 14
|
||||
|
||||
# helps with inlining:
|
||||
# https://www.sphinx-doc.org/en/master/usage/extensions/math.html#confval-imgmath_use_preview
|
||||
imgmath_use_preview = True
|
||||
|
||||
Reference in New Issue
Block a user