Hello.

Another day, another Contributor Journey Optimization improvement.

Just about to get an RC from Airflow, I followed up after all the
restructuring / uv work done and here is one true gem that has been made
possible by that restructuring (or repainting) work -sp improving doc build
iteration speed.

I just completed the docs (in the background of Open Lineage Meetup in
Warsaw) - where I made it super (I think) easy to iterate on our docs.
Something that will be truly needed now - when we likely need to write a
lot of docs for all the new things we created.

Here is hte PR https://github.com/apache/airflow/pull/48760

After this PR is merged, with `uv` and separate distributions and
refactoring and moving the doc code to `devel-common` it's literally as
easy as:

cd devel-common
uv run src/sphinx_exts/docs_build/fetch_inventories.py

This one downloads inventories that documentation links to)

cd <YOUR-DISTRIBUTION>/docs
uv run sphinx-autobuild -T --color -b html  . _build

This will (locally - without breeze) open an auto-refreshing web server
with the documentation build (after some initial startup) . With my tests,
it takes a few seconds for a change in your sources to get automatically
(!) refreshed in your browser (both on airflow-core docs and individual
providers docs).

There is one prerequisite (enchant library) that needs to be set-up locally
(but in the docs I explained how to do it on Mac OS especially). The
"contributing-docs" are already updated in my PR to explain what to do.

Here are the possible distributions you can run that sphinx-autobuild
command in.

* ``airflow-core/docs`` - documentation for Airflow Core
* ``providers/**/docs`` - documentation for Providers (90+ folders)
* ``chart/docs`` - documentation for Helm Chart
* ``task-sdk/docs`` - documentation for Task SDK (new format not yet
published)
* ``airflow-ctl/docs`` - documentation for Airflow CLI (future)

Documentation for general overview and summaries not connected with amy
specific distribution:

* ``docker-stack-docs`` - documentation for Docker Stack'
* ``providers-summary-docs`` - documentation for provider summary page

There will likely be some teething issues - but If you would like to check
the PR out and let me know in #documentation slack channel if you see any
issues - we can solve them before or after.

J.

Reply via email to