The GitHub Actions job "Tests" on airflow.git/improve-documentation-building 
has failed.
Run started by GitHub user potiuk (triggered by potiuk).

Head commit for run:
152e7911a9947cd39bec3d6bf456dd428a02788f / Jarek Potiuk <[email protected]>
Improve documentation building iteration

Building documentation had always been pretty slow and required
using `breeze build-docs` command. This is becuase of the depdendencies
that were needed to be installed, and non-standard setup of the
providers that were not really separated from airflow code.

With the recent distribution separation implemented in airflow code
and isolation implemented in airlfow and all its providers and thanks
to uv workspace that allows to automatically link multiple distributions
in airflow repository - including common development libraries that
are linked between different distributions in the same workspace,
we can now enable documentation building in a very easy way
(using simple sphinx-build commands, as well as enable some of more
advanced features such as sphinx-autobuild to improve iteration
speed when adding and updating documentation.

This PR reworks and repurposes ``build-docs`` command that has
been used inside the container image to be also usable from
regular uv-run local environment. The script has been modernized
and some old and unused code has been removed:

* lint_checks were not really checking anything and those checks
  are covered by provider's template generation
* doc and spelling errors were repeated (and unused) in breeze
* you can use short package names to run teh doc-build script
* the script warns if it is used without ``--group docs``
* the ``docs`` and ``gen-docs`` extras and dependency groups have now
  plural form to follow the ``docs`` folder as well
* rich-click is used for nicer `--help`` output and arg handing

The contributing docs have been updatted with dedicated docs building
page, which explains the various ways you can build docs, set
prerequisites and iterate quickly on the documentation. It also
contains explanation about some typical errors you might encounter
when running Sphinx build.

Various spelling issues have been solved (the new way of
running the docs revealed some spelling errors).

Report URL: https://github.com/apache/airflow/actions/runs/14293254697

With regards,
GitHub Actions via GitBox


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to