Skip to content

Autogenerating API documentation

grantseltzer bpf 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest3 patches 20 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3bpf: Add sphinx documentation build filestools/lib/bpf/docs/conf.py tools/lib/bpf/docs/index.rst tools/lib/bpf/docs/sphinx/Makefile +1 more+63 -00 replies
2/3bpf: Add doxygen configuration filetools/lib/bpf/docs/sphinx/doxygen/Doxyfile+320 -00 replies
3/3bpf: Add rst docs for libbpftools/lib/bpf/docs/api.rst tools/lib/bpf/docs/build.rst tools/lib/bpf/docs/index.rst +1 more+116 -70 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH bpf-next 0/3] Autogenerating API documentation

This series of patches is meant to start the initiative to document libbpf. It includes .rst files which are text documentation describing building, API naming convention, as well as an index to generated API documentation.

The generated API documentation is enabled by Doxygen, which actually parses the code for documentation comment strings and generates XML. A tool called Sphinx then reads this XML with the help of the breathe plugin, as well as the above mentioned .rst files and generates beautiful HTML output.

The goal of this is for readthedocs.io to be able to pick up that generated documentation which will be made possible with the help of readthedoc's github integration and libbpf's official github mirror. Minor setup is required in that mirror once this patch series is merged.

grantseltzer (3):
bpf: Add sphinx documentation build files
bpf: Add doxygen configuration file
bpf: Add rst docs for libbpf

 tools/lib/bpf/docs/api.rst                    |  60 ++++
 tools/lib/bpf/docs/build.rst                  |  39 +++
 tools/lib/bpf/docs/conf.py                    |  38 +++
 tools/lib/bpf/docs/index.rst                  |  21 ++
 .../naming_convention.rst}                    |  18 +-
 tools/lib/bpf/docs/sphinx/Makefile            |   9 +
 tools/lib/bpf/docs/sphinx/doxygen/Doxyfile    | 320 ++++++++++++++++++
 tools/lib/bpf/docs/sphinx/requirements.txt    |   1 +
 8 files changed, 499 insertions(+), 7 deletions(-)
 create mode 100644 tools/lib/bpf/docs/api.rst
 create mode 100644 tools/lib/bpf/docs/build.rst
 create mode 100644 tools/lib/bpf/docs/conf.py
 create mode 100644 tools/lib/bpf/docs/index.rst
 rename tools/lib/bpf/{README.rst => docs/naming_convention.rst} (97%)
 create mode 100644 tools/lib/bpf/docs/sphinx/Makefile
 create mode 100644 tools/lib/bpf/docs/sphinx/doxygen/Doxyfile
 create mode 100644 tools/lib/bpf/docs/sphinx/requirements.txt
Signature · 1 line
2.29.2