mirror of
https://github.com/OpenBluetoothToolbox/SimpleBLE
synced 2025-10-16 22:37:24 +08:00
74 lines
2.5 KiB
Python
74 lines
2.5 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
import pathlib
|
|
import subprocess
|
|
|
|
here = pathlib.Path(__file__).parent.resolve()
|
|
root = here.parent.resolve()
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'SimpleBLE'
|
|
copyright = '2022-2025, The California Open Source Company'
|
|
author = 'Kevin Dewald'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'sphinx_rtd_theme',
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.napoleon",
|
|
'sphinxcontrib.mermaid',
|
|
'breathe'
|
|
]
|
|
|
|
# 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.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# -- External Apps -----------------------------------------------------------
|
|
|
|
subprocess.call('doxygen', shell=True)
|
|
subprocess.call(["pip", "install", "."], cwd=(root / "simplepyble"))
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['_static']
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
breathe_projects = { 'simpleble': '_doxygen/xml',
|
|
'external': '_doxygen/xml'
|
|
}
|
|
|
|
autosummary_generate = True
|