Skip to content

Commit ad5c352

Browse files
authored
Add Sphinx configuration file (conf.py) for documentation setup
- Added conf.py to the docs/ directory to configure Sphinx documentation generation. - Includes project metadata, extensions for autodoc, Napoleon, and viewcode, and paths for templates and static files. - Configured the project source directory in sys.path for generating API documentation. - Set the Alabaster theme for HTML output, with support for ReadTheDocs style if needed. This file provides the foundational configuration required for Sphinx to generate documentation.
1 parent f77c690 commit ad5c352

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/conf.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import os
2+
import sys
3+
4+
# Add the project's source code directory to the system path
5+
sys.path.insert(0, os.path.abspath('../src'))
6+
7+
# Project information
8+
project = 'AI Object Recognition'
9+
author = 'Your Name or Team'
10+
release = '1.0.0'
11+
12+
# 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
17+
]
18+
19+
# Templates and static files
20+
templates_path = ['_templates']
21+
html_static_path = ['_static']
22+
23+
# Files and patterns to exclude from the build
24+
exclude_patterns = []
25+
26+
# HTML theme
27+
html_theme = 'alabaster' # Replace with 'sphinx_rtd_theme' if you prefer ReadTheDocs style

0 commit comments

Comments
 (0)