Spectrax/docs/conf.py at main · erfanzar/Spectrax · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
"""Sphinx configuration for the SpectraX documentation."""

import os
import sys

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

project = "SpectraX"
copyright = "2026, Erfan Zare Chavoshi - SpectraX"
author = "Erfan Zare Chavoshi"

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.doctest",
    "sphinx.ext.intersphinx",
    "sphinx.ext.mathjax",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "myst_nb",
    "sphinx_design",
]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "../CHANGELOG.md"]

intersphinx_mapping = {
    "jax": ("https://jax.readthedocs.io/en/latest/", None),
    "numpy": ("https://numpy.org/doc/stable/", None),
}

html_theme = "sphinx_book_theme"
html_static_path = ["_static"]
html_css_files = [
    "style.css",
]

source_suffix = [".rst", ".md", ".ipynb"]
autosummary_generate = True
myst_enable_extensions = ["colon_fence", "deflist"]
myst_heading_anchors = 3