Skip to content

Commit

Permalink
Fix and format conf.py for linter compliance
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
KazerL authored Nov 15, 2024
1 parent a0b9cf5 commit a9e0e74
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@
import sys

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

# Project information
project = 'AI Object Recognition'
author = 'Your Name or Team'
release = '1.0.0'
project: str = "AI Object Recognition"
author: str = "Your Name or Team"
release: str = "1.0.0"

# Sphinx extensions
extensions = [
'sphinx.ext.autodoc', # Automatically generate documentation from docstrings
'sphinx.ext.napoleon', # Support for NumPy and Google style docstrings
'sphinx.ext.viewcode', # Add links to source code
extensions: list[str] = [
"sphinx.ext.autodoc", # Automatically generate documentation from docstrings
"sphinx.ext.napoleon", # Support for NumPy and Google style docstrings
"sphinx.ext.viewcode", # Add links to source code
]

# Templates and static files
templates_path = ['_templates']
html_static_path = ['_static']
templates_path: list[str] = ["_templates"]
html_static_path: list[str] = ["_static"]

# Files and patterns to exclude from the build
exclude_patterns = []
exclude_patterns: list[str] = []

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

0 comments on commit a9e0e74

Please sign in to comment.