mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-08-25 23:11:14 +00:00
Add documentation. (#321)
Add documentation that covers: - Prediction - Measuremnt - REST API Add Python scripts that support automatic documentation generation using the Sphinx sphinxcontrib.eval extension. Add automatic update/ test for REST API documentation. Filter proxy endpoints from REST API documentation. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
This commit is contained in:
@@ -23,8 +23,8 @@ extensions = [
|
||||
"sphinx.ext.autosummary",
|
||||
"sphinx.ext.napoleon",
|
||||
"sphinx_rtd_theme",
|
||||
# "sphinxcontrib.openapi", buggy
|
||||
"myst_parser",
|
||||
"sphinxcontrib.eval",
|
||||
]
|
||||
|
||||
templates_path = ["_templates"]
|
||||
@@ -80,7 +80,7 @@ myst_url_schemes = {
|
||||
},
|
||||
}
|
||||
myst_number_code_blocks = ["typescript"]
|
||||
myst_heading_anchors = 2
|
||||
myst_heading_anchors = 3
|
||||
myst_footnote_transition = True
|
||||
myst_dmath_double_inline = True
|
||||
myst_enable_checkboxes = True
|
||||
@@ -117,9 +117,6 @@ autodoc_default_options = {
|
||||
# -- Options for autosummary -------------------------------------------------
|
||||
autosummary_generate = True
|
||||
|
||||
# -- Options for openapi -----------------------------------------------------
|
||||
# openapi_default_renderer = "httpdomain:old" buggy
|
||||
|
||||
# -- Options for napoleon -------------------------------------------------
|
||||
napoleon_google_docstring = True
|
||||
napoleon_numpy_docstring = False
|
||||
|
Reference in New Issue
Block a user