Branch: refs/heads/2.0.0
Home:
https://github.com/tribe29/checkmk
Commit: cdd5ac59b339251b3f79661fafb77e049ae2a9da
https://github.com/tribe29/checkmk/commit/cdd5ac59b339251b3f79661fafb77e049…
Author: Andreas Umbreit <andreas.umbreit(a)tribe29.com>
Date: 2021-03-05 (Fri, 05 Mar 2021)
Changed paths:
M cmk/base/plugins/agent_based/agent_based_api/__init__.py
M cmk/base/plugins/agent_based/agent_based_api/v1/__init__.py
M cmk/base/plugins/agent_based/agent_based_api/v1/clusterize.py
M cmk/base/plugins/agent_based/agent_based_api/v1/register.py
M cmk/base/plugins/agent_based/agent_based_api/v1/render.py
M cmk/base/plugins/agent_based/agent_based_api/v1/type_defs.py
M doc/plugin-api/.f12
M doc/plugin-api/Makefile
M doc/plugin-api/source/index.rst
M doc/plugin-api/templates/module.rst_t
M doc/plugin-api/templates/package.rst_t
Log Message:
-----------
CMK-7305: Improve plugins api Sphinx documentation
- Generate toc entries directly from the code (from the docstrings).
apidoc didn't work for us.
- Define starting points in index.rst explicitly instead of by globbing.
- Generate one page for every module in order to obtain a better structure.
- With this, our use of sphinx-apidoc essentially breaks down to
generating some ".. automodule" directives. We can possibly define
these directives more easily manually in the future.
Change-Id: Ib1a632ccdc60634034f80c3c183a520d482d62a0