mbox series

[00/26] Add support for sphinx documentation generation

Message ID 20220317115700.993924-1-richard.purdie@linuxfoundation.org
Headers show
Series Add support for sphinx documentation generation | expand

Message

Richard Purdie March 17, 2022, 11:56 a.m. UTC
We use sphinx for the project documentation. We also build the documentation on the
autobuilder and we use a buildtools-docs-tarball to do it that I created a couple of
years ago using recipes upon which this series is based.

We'd like to be able to generate this tarball from the metadata so I've cleaned up
the patches and present them in this series. The first version back in 2020 was 
from Armin, I've since made changes including sorting out the LICENSE fields.

We have a dilemma of whether to do this in meta-python or core. I'm personally
torn but a number of the base dependencies such as urllib3 and requests should
probably be in core anyway which ended up being the deciding factor. This does
mean we can include docs build tools in build images out the box in future too.

Of note is that as well as adding the buildtools-docs-tarball, a test is also
added using the mechanism Ross used for adding tests to buildtools-tarball. This
makes for a pretty neat test that tests whether the resulting docs tarball can
actually work and generate our docs.

Richard Purdie (26):
  python3-docutil: Extend to nativesdk
  python3-snowballstemmer: Add new recipe
  python3-imagesize: Add new recipe
  python3-alabaster: Add new recipe
  python3-pyasn1: Add from meta-oe/meta-python
  python3-certifi: Add from meta-oe/meta-python
  python3-chardet: Add from meta-oe/meta-python
  python3-ndg-httpsclient: Add from meta-oe/meta-python
  python3-pyopenssl: Add from meta-oe/meta-python
  python3-pysocks: Add from meta-oe/meta-python
  python3-pytest-runner: Add from meta-oe/meta-python
  python3-requests: Add from meta-oe/meta-python
  python3-urllib3: Add from meta-oe/meta-python
  python3-babel: Add recipe from meta-oe/meta-python
  python3-sphinxcontrib-qthelp: Add new recipe
  python3-sphinxcontrib-devhelp: Add new recipe
  python3-sphinxcontrib-htmlhelp: Add new recipe
  python3-sphinxcontrib-serializinghtml: Add new recipe
  python3-sphinxcontrib-jsmath: Add new recipe
  python3-sphinxcontrib-applehelp: add new recipe
  python3-sphinx-rtd-theme: Add new recipe
  python3-sphinx: Add a new recipe
  python3: Add missing HOMEPAGE entries
  maintainers.inc: Add new python recipes
  Add buildtools-docs-tarball recipe
  buildtools-docs-tarball: Add test for building documentation using
    sphinx

 meta/conf/distro/include/maintainers.inc      | 24 +++++++++++++-
 .../lib/oeqa/sdk/buildtools-docs-cases/README |  2 ++
 .../oeqa/sdk/buildtools-docs-cases/build.py   | 17 ++++++++++
 .../meta/buildtools-docs-tarball.bb           | 18 +++++++++++
 meta/recipes-core/meta/buildtools-tarball.bb  |  5 ++-
 .../recipes-devtools/python/python-pyasn1.inc | 31 +++++++++++++++++++
 .../python/python3-alabaster_0.7.12.bb        | 11 +++++++
 .../python/python3-babel_2.9.1.bb             | 26 ++++++++++++++++
 .../python/python3-certifi_2021.10.8.bb       | 14 +++++++++
 .../python/python3-chardet_4.0.0.bb           | 24 ++++++++++++++
 .../python/python3-docutils_0.18.1.bb         |  2 +-
 .../python/python3-imagesize_1.2.0.bb         | 11 +++++++
 .../python/python3-ndg-httpsclient_0.5.1.bb   | 31 +++++++++++++++++++
 .../python/python3-pyasn1/run-ptest           |  3 ++
 .../python/python3-pyasn1_0.4.8.bb            |  2 ++
 .../python/python3-pyopenssl_22.0.0.bb        | 23 ++++++++++++++
 .../python/python3-pysocks_1.7.1.bb           | 20 ++++++++++++
 .../python/python3-pytest-runner_5.3.1.bb     | 16 ++++++++++
 .../python/python3-requests_2.27.1.bb         | 25 +++++++++++++++
 .../python/python3-snowballstemmer_2.2.0.bb   | 13 ++++++++
 .../python/python3-sphinx-rtd-theme_0.5.0.bb  | 21 +++++++++++++
 .../python/python3-sphinx_4.4.0.bb            | 22 +++++++++++++
 .../python3-sphinxcontrib-applehelp_1.0.2.bb  | 12 +++++++
 .../python3-sphinxcontrib-devhelp_1.0.2.bb    | 12 +++++++
 .../python3-sphinxcontrib-htmlhelp_2.0.0.bb   | 12 +++++++
 .../python3-sphinxcontrib-jsmath_1.0.1.bb     | 12 +++++++
 .../python3-sphinxcontrib-qthelp_1.0.3.bb     | 12 +++++++
 ...on3-sphinxcontrib-serializinghtml_1.1.5.bb | 12 +++++++
 .../python/python3-urllib3_1.26.8.bb          | 22 +++++++++++++
 29 files changed, 452 insertions(+), 3 deletions(-)
 create mode 100644 meta/lib/oeqa/sdk/buildtools-docs-cases/README
 create mode 100644 meta/lib/oeqa/sdk/buildtools-docs-cases/build.py
 create mode 100644 meta/recipes-core/meta/buildtools-docs-tarball.bb
 create mode 100644 meta/recipes-devtools/python/python-pyasn1.inc
 create mode 100644 meta/recipes-devtools/python/python3-alabaster_0.7.12.bb
 create mode 100644 meta/recipes-devtools/python/python3-babel_2.9.1.bb
 create mode 100644 meta/recipes-devtools/python/python3-certifi_2021.10.8.bb
 create mode 100644 meta/recipes-devtools/python/python3-chardet_4.0.0.bb
 create mode 100644 meta/recipes-devtools/python/python3-imagesize_1.2.0.bb
 create mode 100644 meta/recipes-devtools/python/python3-ndg-httpsclient_0.5.1.bb
 create mode 100644 meta/recipes-devtools/python/python3-pyasn1/run-ptest
 create mode 100644 meta/recipes-devtools/python/python3-pyasn1_0.4.8.bb
 create mode 100644 meta/recipes-devtools/python/python3-pyopenssl_22.0.0.bb
 create mode 100644 meta/recipes-devtools/python/python3-pysocks_1.7.1.bb
 create mode 100644 meta/recipes-devtools/python/python3-pytest-runner_5.3.1.bb
 create mode 100644 meta/recipes-devtools/python/python3-requests_2.27.1.bb
 create mode 100644 meta/recipes-devtools/python/python3-snowballstemmer_2.2.0.bb
 create mode 100644 meta/recipes-devtools/python/python3-sphinx-rtd-theme_0.5.0.bb
 create mode 100644 meta/recipes-devtools/python/python3-sphinx_4.4.0.bb
 create mode 100644 meta/recipes-devtools/python/python3-sphinxcontrib-applehelp_1.0.2.bb
 create mode 100644 meta/recipes-devtools/python/python3-sphinxcontrib-devhelp_1.0.2.bb
 create mode 100644 meta/recipes-devtools/python/python3-sphinxcontrib-htmlhelp_2.0.0.bb
 create mode 100644 meta/recipes-devtools/python/python3-sphinxcontrib-jsmath_1.0.1.bb
 create mode 100644 meta/recipes-devtools/python/python3-sphinxcontrib-qthelp_1.0.3.bb
 create mode 100644 meta/recipes-devtools/python/python3-sphinxcontrib-serializinghtml_1.1.5.bb
 create mode 100644 meta/recipes-devtools/python/python3-urllib3_1.26.8.bb