From ad5c352906a8e9ee26340f9bd26aa9403ae5d907 Mon Sep 17 00:00:00 2001 From: KazerL Date: Fri, 15 Nov 2024 18:12:54 -0500 Subject: [PATCH] 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. --- docs/conf.py | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/conf.py diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..bf0a4a7 --- /dev/null +++ b/docs/conf.py @@ -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