]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
python3-sphinx-argparse: add recipe
authorAntonin Godard <antonin.godard@bootlin.com>
Thu, 26 Jun 2025 15:15:43 +0000 (17:15 +0200)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Tue, 1 Jul 2025 07:47:23 +0000 (08:47 +0100)
This Sphinx extension can be used to autogenerate documentation for any
python module returning an argument parser from argparse. It can used in
places of the documentation where the --help output is currently
hardcoded, and generate formatted documentation instead.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
meta/conf/distro/include/maintainers.inc
meta/recipes-devtools/python/python3-sphinx-argparse_0.5.2.bb [new file with mode: 0644]

index d94fb693e39ae2221a20f5f821a9adabf6ee55c0..c20fd6b27b3a6102de26a2133c944632427dfbfa 100644 (file)
@@ -718,6 +718,7 @@ RECIPE_MAINTAINER:pn-python3-snowballstemmer = "Tim Orling <tim.orling@konsulko.
 RECIPE_MAINTAINER:pn-python3-sortedcontainers = "Tim Orling <tim.orling@konsulko.com>"
 RECIPE_MAINTAINER:pn-python3-spdx-tools = "Marta Rybczynska <marta.rybczynska@ygreky.com>"
 RECIPE_MAINTAINER:pn-python3-sphinx = "Trevor Gamblin <tgamblin@baylibre.com>"
+RECIPE_MAINTAINER:pn-python3-sphinx-argparse = "Antonin Godard <antonin.godard@bootlin.com>"
 RECIPE_MAINTAINER:pn-python3-sphinx-rtd-theme = "Tim Orling <tim.orling@konsulko.com>"
 RECIPE_MAINTAINER:pn-python3-sphinxcontrib-applehelp = "Tim Orling <tim.orling@konsulko.com>"
 RECIPE_MAINTAINER:pn-python3-sphinxcontrib-devhelp = "Tim Orling <tim.orling@konsulko.com>"
diff --git a/meta/recipes-devtools/python/python3-sphinx-argparse_0.5.2.bb b/meta/recipes-devtools/python/python3-sphinx-argparse_0.5.2.bb
new file mode 100644 (file)
index 0000000..554fb3e
--- /dev/null
@@ -0,0 +1,13 @@
+SUMMARY = "A sphinx extension that automatically documents argparse commands and options"
+HOMEPAGE = "https://sphinx-argparse.readthedocs.io/"
+LICENSE = "MIT"
+LIC_FILES_CHKSUM = "file://LICENCE.rst;md5=5c1cd8f13774629fee215681e66a1056"
+
+SRC_URI[sha256sum] = "e5352f8fa894b6fb6fda0498ba28a9f8d435971ef4bbc1a6c9c6414e7644f032"
+
+PYPI_PACKAGE = "sphinx_argparse"
+UPSTREAM_CHECK_PYPI_PACKAGE = "${PYPI_PACKAGE}"
+
+inherit pypi python_flit_core
+
+BBCLASSEXTEND = "native nativesdk"