mirror of
https://github.com/apache/airflow.git
synced 2026-11-04 07:12:48 +00:00
Jarek Potiuk
67858fd7e7
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).
82 lines
2.4 KiB
TOML
82 lines
2.4 KiB
TOML
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
[build-system]
|
|
requires = [
|
|
"hatchling==1.27.0",
|
|
]
|
|
build-backend = "hatchling.build"
|
|
|
|
[project]
|
|
name = "apache-airflow-docker-stack"
|
|
description = "Programmatically author, schedule and monitor data pipelines"
|
|
requires-python = "~=3.9,<3.13"
|
|
authors = [
|
|
{ name = "Apache Software Foundation", email = "dev@airflow.apache.org" },
|
|
]
|
|
maintainers = [
|
|
{ name = "Apache Software Foundation", email="dev@airflow.apache.org" },
|
|
]
|
|
keywords = [ "airflow", "orchestration", "workflow", "dag", "pipelines", "automation", "data" ]
|
|
classifiers = [
|
|
"Development Status :: 5 - Production/Stable",
|
|
"Environment :: Console",
|
|
"Environment :: Web Environment",
|
|
"Framework :: Apache Airflow",
|
|
"Intended Audience :: Developers",
|
|
"Intended Audience :: System Administrators",
|
|
"License :: OSI Approved :: Apache Software License",
|
|
"Programming Language :: Python :: 3.9",
|
|
"Programming Language :: Python :: 3.10",
|
|
"Programming Language :: Python :: 3.11",
|
|
"Programming Language :: Python :: 3.12",
|
|
"Topic :: System :: Monitoring",
|
|
"Topic :: System :: Monitoring",
|
|
]
|
|
|
|
version = "0.0.1"
|
|
|
|
dependencies = [
|
|
"apache-airflow-core",
|
|
"apache-airflow-devel-common",
|
|
]
|
|
|
|
[tool.hatch.build.targets.sdist]
|
|
exclude = ["*"]
|
|
|
|
[tool.hatch.build.targets.wheel]
|
|
bypass-selection = true
|
|
|
|
[dependency-groups]
|
|
# To build docs run:
|
|
#
|
|
# uv run --group docs sphinx-build -T --color -b html . _build
|
|
#
|
|
# To check spelling:
|
|
#
|
|
# uv run --group docs sphinx-build -T --color -b spelling . _build
|
|
#
|
|
# To enable auto-refreshing build with server:
|
|
#
|
|
# uv run --group docs sphinx-autobuild -T --color -b html . _build
|
|
#
|
|
docs = [
|
|
"apache-airflow-devel-common[docs]"
|
|
]
|
|
|
|
packages = []
|