Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-09-13 07:21:16 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add API documentation generation and use Markdown (#160)

Browse Source 
* Add package API documentation generation

Add generation of the API documentation for akkudoktoreos
and akkudoktoreosserver packages.

The API documentation is generated by the Sphinx autosummary extension.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

* Enable Google style source commenting and documentation generation.

Enable automatic documentation generation from Google style docstrings in the source.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

* Check Google style source commenting.

Check Google style commenting by the appropriate ruff rules.

Commenting is _NOT_ enforced. Missing docstrings are ignored.

Minor commenting quirks of the code base are adapted.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

* Improve Markdown handling and switch to Markdown documentation.

Switch to Markdown for the documentation files to improve the user and developer experience (see issue #181).

Keep files with special directives for automatic API documentation in RST format. The
directives expect RST.

Also add dummy handling for openai/ swagger server documentation. The openai interface definition is
for now taken from the fastapi PR as EOS will switch to fastAPI.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

---------

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
Co-authored-by: Normann <github@koldrack.com>
This commit is contained in:
Bobby Noelte
2024-11-10 23:27:52 +01:00
committed by GitHub
parent 3652298134
commit 94467e1a69
28 changed files with 1287 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
pyproject.toml
View File

@@ -45,9 +45,28 @@ profile = "black"
line-length = 100
[tool.ruff.lint]
ignore = [
"F841", # don't complain about unused variables
select = [
"F", # Enable all `Pyflakes` rules.
"D", # Enable all `pydocstyle` rules, limiting to those that adhere to the
# Google convention via `convention = "google"`, below.
]
ignore = [
# On top of `Pyflakes (F)` to prevent errors for existing sources. Should be removed!!!
"F841", # unused-variable: Local variable {name} is assigned to but never used
# On top of `pydocstyle (D)` to prevent errors for existing sources. Should be removed!!!
"D100", # undocumented-public-module: Missing docstring in public module
"D101", # undocumented-public-class: Missing docstring in public class
"D102", # undocumented-public-method: Missing docstring in public method
"D103", # undocumented-public-function: Missing docstring in public function
"D104", # undocumented-public-package: Missing docstring in public package
"D105", # undocumented-magic-method: Missing docstring in magic method
"D106", # undocumented-public-nested-class: Missing docstring in public nested class
"D107", # undocumented-public-init: Missing docstring in __init__
"D417", # undocumented-param: Missing argument description in the docstring for {definition}: {name}
]
[tool.ruff.lint.pydocstyle]
convention = "google"
[tool.pytest.ini_options]
minversion = "8.3.3"