mirror of
https://github.com/OS-Copilot/OS-Copilot.git
synced 2026-04-13 03:00:19 -04:00
46 lines
1.3 KiB
Python
46 lines
1.3 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 sphinx_rtd_theme
|
|
import os
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath('../..'))
|
|
|
|
project = 'OS-Copilot'
|
|
copyright = '2024, OS-Copilot'
|
|
author = 'OS-Copilot'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.napoleon',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
|
|
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 = 'sphinx_rtd_theme'
|
|
html_theme_options = {
|
|
'collapse_navigation': True,
|
|
'sticky_navigation': True,
|
|
'navigation_depth': 4,
|
|
'includehidden': True,
|
|
'titles_only': False
|
|
}
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
|
html_static_path = ['_static']
|