Skip to content

Commit

Permalink
Add Sphinx configuration file (conf.py) for documentation setup
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
KazerL authored Nov 15, 2024
1 parent f77c690 commit ad5c352
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import os
import sys

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

# Project information
project = 'AI Object Recognition'
author = 'Your Name or Team'
release = '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
]

# Templates and static files
templates_path = ['_templates']
html_static_path = ['_static']

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

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

0 comments on commit ad5c352

Please sign in to comment.