Skip to content

Commit b1e7a57

Browse files
committed
Create Sphinx documentation configuration file
1 parent 757f540 commit b1e7a57

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

docs/conf.py

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'DBDuck'
10+
copyright = '2026, Veeresh Hanni'
11+
author = 'Veeresh Hanni'
12+
release = '0.1.0'
13+
14+
# -- General configuration ---------------------------------------------------
15+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16+
17+
extensions = [
18+
'sphinx.ext.autodoc',
19+
'sphinx.ext.viewcode',
20+
'sphinx.ext.napoleon',
21+
]
22+
23+
templates_path = ['_templates']
24+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
25+
26+
language = 'en'
27+
28+
# -- Options for HTML output -------------------------------------------------
29+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
30+
31+
html_theme = 'sphinx_rtd_theme'
32+
html_static_path = ['_static']
33+
34+
# -- Options for autodoc ---------------------------------------------------
35+
autodoc_default_options = {
36+
'members': True,
37+
'member-order': 'bysource',
38+
'special-members': '__init__',
39+
'undoc-members': True,
40+
'show-inheritance': True,
41+
}

0 commit comments

Comments
 (0)