ruopus 0.1.1

A pure-Rust implementation of the Opus audio codec (RFC 6716). No FFI; unsafe confined to documented SIMD kernels.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

"""Sphinx configuration for the ruopus Python API documentation.

Docstrings are single-sourced from the Rust ``///`` comments: PyO3 emits them
as ``__doc__`` on the compiled module, and ``autodoc`` reads them here. The
``napoleon`` extension renders the NumPy-style sections (Parameters/Returns/
Raises/Examples) the docstrings are written in. Build with::

    pip install ruopus[docs] && sphinx-build -W docs/python docs/python/_build
"""

import importlib.metadata

project = "ruopus"
author = "Jack Geraghty"
try:
    release = importlib.metadata.version("ruopus")
except importlib.metadata.PackageNotFoundError:
    release = "0.1.0"

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.napoleon",
    "sphinx.ext.intersphinx",
    "sphinx.ext.viewcode",
]

autosummary_generate = True
autodoc_member_order = "bysource"
autodoc_default_options = {
    "members": True,
    "undoc-members": False,
    "show-inheritance": True,
}
napoleon_numpy_docstring = True
napoleon_google_docstring = False

intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
    "numpy": ("https://numpy.org/doc/stable", None),
}

html_theme = "alabaster"
templates_path = ["_templates"]
exclude_patterns = ["_build"]