🔧 Sphinx documentation configuration

docs/conf.py

@@ -1,37 +1,34 @@
 import os
 import sys
 
+# Add project directory to sys.path for autodoc to find your modules
 sys.path.insert(0, os.path.abspath("../YOLO-detect_buoys"))
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+# Project information
 project = "vortex image build"
 copyright = "2024, Yauhen Yavorski"
 author = "Yauhen Yavorski"
 
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+# General configuration
+extensions = [
+    "sphinx.ext.autodoc",  # Automatically document docstrings
+    "sphinx.ext.napoleon",  # Support for Google-style and NumPy-style docstrings
+    "sphinx.ext.viewcode",  # Link to source code in the docs
+    "sphinx.ext.autosummary",  # Generate summaries of functions/classes
+    "myst_parser",  # Support for Markdown files (optional)
+]
 
-extensions = []
+# Automatically generate autosummary pages
+autosummary_generate = True
 
+# Napoleon settings (optional)
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+
+# Templates and exclude patterns
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_theme = "alabaster"
+# Options for HTML output (theme and static paths)
+html_theme = "sphinx_rtd_theme"  # Change to ReadTheDocs theme
 html_static_path = ["_static"]
-
-extensions = [
-    "sphinx.ext.autodoc",  # To automatically document docstrings
-    "sphinx.ext.napoleon",  # To support Google-style and NumPy-style docstrings
-    "sphinx.ext.viewcode",  # To link to the source code
-    "sphinx.ext.autosummary",  # To create summaries of your code
-]

docs/index.rst

@@ -15,3 +15,12 @@ documentation for details.
    :maxdepth: 2
    :caption: Contents:
 
+    installation
+    usage
+    examples
+    api
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`