M
muq
a68a325cb4
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 6m4s
Build Project / Build Project (3.10) (pull_request) Successful in 11m52s
Build Project / Build Project (3.11) (pull_request) Successful in 11m50s
Build Project / Build Project (3.12) (pull_request) Successful in 11m51s
Test with tox / Test with tox (3.11) (pull_request) Successful in 12m10s
Test with tox / Test with tox (3.12) (pull_request) Successful in 6m22s
Test with tox / Test with tox (3.10) (pull_request) Successful in 12m28s
Fix Sphinx build errors: - Add missing blank lines in rtlsdr.rst code-block directives - Rename duplicate label in examples/sdr/index.rst - Fix field list indentation in usrp.py and hackrf.py docstrings Update SDR setup guides (all guides now cover both pip/venv and Radioconda): - rtlsdr: switch to rtl-sdr-blog fork (required for rtlsdr_set_dithering symbol), add pyrtlsdr==0.3.0 and setuptools==69.5.1 version pinning, preserve Radioconda blacklist and udev symlink paths alongside new steps - pluto: simplify primary path to apt install libiio, add Avahi network discovery note, preserve Radioconda udev symlink as alternative - hackrf: note out-of-box support, preserve Radioconda udev symlink - blade: note no extra Python packages needed, preserve Radioconda udev symlinks - usrp: add build-from-source path for pip/venv users with cmake flags, Python binding copy step, and version mismatch warning; keep conda install as primary option; preserve Radioconda udev symlink - thinkrf: add lib2to3 install step, Python <=3.12 restriction, and full Python 3 patching command to replace internal script reference Update copyright year to 2026 in conf.py
79 lines
2.7 KiB
Python
79 lines
2.7 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
|
|
|
|
# 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 = 'ria-toolkit-oss'
|
|
copyright = '2026, Qoherent Inc'
|
|
author = 'Qoherent Inc.'
|
|
release = '0.1.5'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.intersphinx'
|
|
]
|
|
|
|
autodoc_typehints = "none"
|
|
|
|
autodoc_typehints_format = "short"
|
|
python_use_unqualified_type_names = True
|
|
|
|
todo_include_todos = True
|
|
|
|
templates_path = ['.templates']
|
|
exclude_patterns = []
|
|
|
|
# These modules are required for SDR hardware support, but are not listed
|
|
# as Python dependencies in pyproject.toml because they must be installed
|
|
# separately (often with system-level drivers or vendor packages).
|
|
# We mock them here so Sphinx can build the documentation without requiring
|
|
# the actual hardware libraries to be present.
|
|
autodoc_mock_imports = ['uhd', 'adi', 'iio', 'bladerf']
|
|
|
|
autodoc_default_options = {
|
|
'members': True,
|
|
'special-members': '__call__'
|
|
}
|
|
|
|
version_link = f"{sys.version_info.major}.{sys.version_info.minor}"
|
|
intersphinx_mapping = {'python': (f'https://docs.python.org/{version_link}', None),
|
|
'numpy': ('https://numpy.org/doc/stable', None),
|
|
'scipy': ('https://docs.scipy.org/doc/scipy', None),
|
|
'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None),
|
|
'h5py': ('https://docs.h5py.org/en/stable', None),
|
|
'plotly': ('https://plotly.com/python-api-reference', None)}
|
|
|
|
|
|
def autodoc_process_docstring(app, what, name, obj, options, lines):
|
|
for i in range(len(lines)):
|
|
lines[i] = lines[i].replace("np.", "numpy.")
|
|
|
|
|
|
autodoc_member_order = 'bysource'
|
|
|
|
|
|
def setup(app):
|
|
app.connect("autodoc-process-docstring", autodoc_process_docstring)
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_static_path = ['_static']
|
|
html_css_files = ['custom.css']
|
|
html_js_files = ['custom.js']
|