45 lines
1.0 KiB
Python
45 lines
1.0 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
import os
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath('..'))
|
|
|
|
# Project information
|
|
project = 'photonglass'
|
|
copyright = '2024, photonglass'
|
|
author = 'AliMickey'
|
|
release = '1.0.0'
|
|
|
|
# General configuration
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.napoleon',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.githubpages',
|
|
'sphinx_rtd_theme',
|
|
'sphinx.ext.intersphinx',
|
|
'myst_parser'
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# HTML output options
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_static_path = ['_static']
|
|
html_title = 'Looking Glass Documentation'
|
|
|
|
# Intersphinx configuration
|
|
intersphinx_mapping = {
|
|
'python': ('https://docs.python.org/3', None),
|
|
'flask': ('https://flask.palletsprojects.com/en/2.3.x/', None),
|
|
}
|
|
|
|
# autodoc configuration
|
|
autodoc_default_options = {
|
|
'members': True,
|
|
'member-order': 'bysource',
|
|
'special-members': '__init__',
|
|
'undoc-members': True,
|
|
'exclude-members': '__weakref__'
|
|
}
|