sphinx_documentation_conf_py_quickstart_with_autodoc_napoleon.py

1# Configuration file for the Sphinx documentation builder.
2#
3# For the full list of built-in configuration values, see the documentation:
4# https://www.sphinx-doc.org/en/master/usage/configuration.html
5
6import os
7import sys
8
9# -- Project information -----------------------------------------------------
10# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
11
12project = 'My Project'
13copyright = '2024, Author Name'
14author = 'Author Name'
15release = '0.1'
16
17# -- General configuration ---------------------------------------------------
18# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
19
20extensions = [
21    'sphinx.ext.autodoc',
22    'sphinx.ext.viewcode',
23    'sphinx.ext.napoleon',
24]
25
26templates_path = ['_templates']
27exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
28
29# -- Options for HTML output -------------------------------------------------
30# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
31
32html_theme = 'alabaster'
33html_static_path = ['_static']