mirror of
https://github.com/ZGCA-Forge/MsgCenterPy.git
synced 2025-12-14 13:04:34 +00:00
136 lines
3.5 KiB
Python
136 lines
3.5 KiB
Python
"""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
|
|
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath(".."))
|
|
|
|
# Import version from package
|
|
try:
|
|
from msgcenterpy import __version__
|
|
|
|
version = __version__
|
|
except ImportError:
|
|
version = "0.0.1" # fallback
|
|
|
|
project = "MsgCenterPy"
|
|
copyright = "2025, MsgCenterPy Team"
|
|
author = "MsgCenterPy Team"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.todo",
|
|
"sphinx.ext.coverage",
|
|
"sphinx.ext.mathjax",
|
|
"myst_parser",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
language = "en"
|
|
|
|
# -- 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"]
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
# Napoleon settings
|
|
napoleon_google_docstring = True
|
|
napoleon_numpy_docstring = True
|
|
napoleon_include_init_with_doc = False
|
|
napoleon_include_private_with_doc = False
|
|
napoleon_include_special_with_doc = True
|
|
napoleon_use_admonition_for_examples = False
|
|
napoleon_use_admonition_for_notes = False
|
|
napoleon_use_admonition_for_references = False
|
|
napoleon_use_ivar = False
|
|
napoleon_use_param = True
|
|
napoleon_use_rtype = True
|
|
|
|
# Autodoc settings
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
"member-order": "bysource",
|
|
"special-members": "__init__",
|
|
"undoc-members": True,
|
|
"exclude-members": "__weakref__",
|
|
}
|
|
|
|
# Intersphinx mapping
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
"numpy": ("https://numpy.org/doc/stable", None),
|
|
"pydantic": ("https://docs.pydantic.dev", None),
|
|
}
|
|
|
|
# MyST parser settings
|
|
myst_enable_extensions = [
|
|
"deflist",
|
|
"tasklist",
|
|
"dollarmath",
|
|
"amsmath",
|
|
"colon_fence",
|
|
"attrs_inline",
|
|
]
|
|
|
|
# Todo settings
|
|
todo_include_todos = True
|
|
|
|
# HTML theme options
|
|
html_theme_options = {
|
|
"canonical_url": "",
|
|
"analytics_id": "", # Provided by Google in your dashboard
|
|
"logo_only": False,
|
|
"display_version": True,
|
|
"prev_next_buttons_location": "bottom",
|
|
"style_external_links": False,
|
|
"vcs_pageview_mode": "",
|
|
"style_nav_header_background": "#2980B9",
|
|
# Toc options
|
|
"collapse_navigation": True,
|
|
"sticky_navigation": True,
|
|
"navigation_depth": 4,
|
|
"includehidden": True,
|
|
"titles_only": False,
|
|
}
|
|
|
|
# Custom sidebar
|
|
html_sidebars = {
|
|
"**": [
|
|
"about.html",
|
|
"navigation.html",
|
|
"relations.html",
|
|
"searchbox.html",
|
|
"donate.html",
|
|
]
|
|
}
|
|
|
|
# -- Custom CSS and JS -------------------------------------------------------
|
|
html_css_files = ["custom.css"]
|
|
|
|
# GitHub URL
|
|
html_context = {
|
|
"display_github": True, # Integrate GitHub
|
|
"github_user": "ZGCA-Forge", # Username
|
|
"github_repo": "MsgCenterPy", # Repo name
|
|
"github_version": "main", # Version
|
|
"conf_py_path": "/docs/", # Path in the checkout to the docs root
|
|
}
|