mirror of
https://github.com/naruxde/revpimodio2.git
synced 2026-03-31 15:08:09 +02:00
2eac69b7bd
Created topic-based documentation: - basics.rst: core concepts and fundamental usage - cyclic_programming.rst: PLC-style programming with Cycletools - event_programming.rst: event-driven patterns and callbacks - advanced.rst: gateway IOs, replace_io_file, watchdog management - installation.rst and quickstart.rst: getting started guides Added complete API reference in docs/api/: - All device classes including ModularBaseConnect_4_5 and GatewayMixin - I/O, helper, and main class documentation Enhanced Sphinx configuration with RTD theme and improved autodoc settings. Removed auto-generated modules.rst and revpimodio2.rst.
88 lines
2.3 KiB
Python
88 lines
2.3 KiB
Python
# coding=utf-8
|
|
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath('../src'))
|
|
from revpimodio2 import __version__
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'revpimodio2'
|
|
copyright = '2023, Sven Sager'
|
|
author = 'Sven Sager'
|
|
version = __version__
|
|
release = __version__
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.napoleon',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.autosummary',
|
|
'sphinx.ext.todo',
|
|
]
|
|
|
|
# Autodoc configuration
|
|
autodoc_default_options = {
|
|
'members': True,
|
|
'member-order': 'bysource',
|
|
'special-members': '__init__',
|
|
'undoc-members': True,
|
|
'exclude-members': '__weakref__'
|
|
}
|
|
|
|
# Napoleon settings (for NumPy and Google style docstrings)
|
|
napoleon_google_docstring = True
|
|
napoleon_numpy_docstring = True
|
|
napoleon_include_init_with_doc = True
|
|
napoleon_include_private_with_doc = False
|
|
napoleon_include_special_with_doc = True
|
|
napoleon_use_admonition_for_examples = True
|
|
napoleon_use_admonition_for_notes = True
|
|
napoleon_use_admonition_for_references = True
|
|
napoleon_use_ivar = False
|
|
napoleon_use_param = True
|
|
napoleon_use_rtype = True
|
|
napoleon_preprocess_types = True
|
|
napoleon_type_aliases = None
|
|
napoleon_attr_annotations = True
|
|
|
|
# Autosummary settings
|
|
autosummary_generate = True
|
|
|
|
# Intersphinx configuration
|
|
intersphinx_mapping = {
|
|
'python': ('https://docs.python.org/3', None),
|
|
}
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_static_path = ['_static']
|
|
|
|
# Theme options
|
|
html_theme_options = {
|
|
'navigation_depth': 4,
|
|
'collapse_navigation': False,
|
|
'sticky_navigation': True,
|
|
'includehidden': True,
|
|
'titles_only': False
|
|
}
|
|
|
|
# -- Options for todo extension ----------------------------------------------
|
|
|
|
todo_include_todos = True
|