Skip to content

Commit a9e0e74

Browse files
authored
Fix and format conf.py for linter compliance
- Applied black formatting to standardize the code style in conf.py. - Added type annotations to satisfy mypy requirements. - Ensured proper configuration of Sphinx extensions and paths. - Updated quotes and alignment for consistency.
1 parent a0b9cf5 commit a9e0e74

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/conf.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22
import sys
33

44
# Add the project's source code directory to the system path
5-
sys.path.insert(0, os.path.abspath('../src'))
5+
sys.path.insert(0, os.path.abspath("../src"))
66

77
# Project information
8-
project = 'AI Object Recognition'
9-
author = 'Your Name or Team'
10-
release = '1.0.0'
8+
project: str = "AI Object Recognition"
9+
author: str = "Your Name or Team"
10+
release: str = "1.0.0"
1111

1212
# Sphinx extensions
13-
extensions = [
14-
'sphinx.ext.autodoc', # Automatically generate documentation from docstrings
15-
'sphinx.ext.napoleon', # Support for NumPy and Google style docstrings
16-
'sphinx.ext.viewcode', # Add links to source code
13+
extensions: list[str] = [
14+
"sphinx.ext.autodoc", # Automatically generate documentation from docstrings
15+
"sphinx.ext.napoleon", # Support for NumPy and Google style docstrings
16+
"sphinx.ext.viewcode", # Add links to source code
1717
]
1818

1919
# Templates and static files
20-
templates_path = ['_templates']
21-
html_static_path = ['_static']
20+
templates_path: list[str] = ["_templates"]
21+
html_static_path: list[str] = ["_static"]
2222

2323
# Files and patterns to exclude from the build
24-
exclude_patterns = []
24+
exclude_patterns: list[str] = []
2525

2626
# HTML theme
27-
html_theme = 'alabaster' # Replace with 'sphinx_rtd_theme' if you prefer ReadTheDocs style
27+
html_theme: str = "alabaster" # Replace with 'sphinx_rtd_theme' if you prefer ReadTheDocs style

0 commit comments

Comments
 (0)