mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-04-19 08:55:15 +00:00
6561793e3b
* 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>
15 lines
708 B
Markdown
15 lines
708 B
Markdown
% SPDX-License-Identifier: Apache-2.0
|
|
|
|
# Welcome to the EOS documentation!
|
|
|
|
This documentation is continuously written. It is edited via text files in the
|
|
[Markdown/ Markedly Structured Text](https://myst-parser.readthedocs.io/en/latest/index.html)
|
|
markup language and then compiled into a static website/ offline document using the open source tool
|
|
[Sphinx](https://www.sphinx-doc.org) and will someday land on
|
|
[Read the Docs](https://akkudoktoreos.readthedocs.io/en/latest/index.html).
|
|
|
|
You can contribute to EOS's documentation by opening
|
|
[GitHub issues](https://github.com/Akkudoktor-EOS/EOS/issues)
|
|
or sending patches via pull requests on its
|
|
[GitHub repository](https://github.com/Akkudoktor-EOS/EOS).
|