good starting point for docs

This commit is contained in:
crumbtoo
2023-11-14 09:20:25 -07:00
parent 5edbd733ac
commit 70f3b5cde2
5 changed files with 98 additions and 0 deletions

48
docs/src/conf.py Normal file
View 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