You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
1.8 KiB
67 lines
1.8 KiB
# 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 = 'BadGUI' |
|
copyright = '2025, BadGUI Team' |
|
author = 'BadGUI Team' |
|
release = '1.0.0' |
|
|
|
# -- General configuration --------------------------------------------------- |
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
|
|
|
import os |
|
import sys |
|
sys.path.insert(0, os.path.abspath('../../')) # Add badgui to path |
|
|
|
extensions = [ |
|
'sphinx.ext.autodoc', |
|
'sphinx.ext.viewcode', |
|
'sphinx.ext.napoleon', |
|
'sphinx.ext.intersphinx', |
|
'sphinx_autodoc_typehints', |
|
'myst_parser', |
|
] |
|
|
|
templates_path = ['_templates'] |
|
exclude_patterns = [] |
|
|
|
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 |
|
|
|
# Intersphinx mapping |
|
intersphinx_mapping = { |
|
'python': ('https://docs.python.org/3', None), |
|
} |
|
|
|
# MyST parser settings |
|
myst_heading_anchors = 3 |
|
myst_enable_extensions = [ |
|
"colon_fence", |
|
"deflist", |
|
"html_admonition", |
|
"html_image", |
|
"linkify", |
|
"replacements", |
|
"smartquotes", |
|
"strikethrough", |
|
"substitution", |
|
"tasklist", |
|
]
|
|
|