vincbeck commented on code in PR #48760: URL: https://github.com/apache/airflow/pull/48760#discussion_r2027502683
########## contributing-docs/11_documentation_building.rst: ########## @@ -0,0 +1,160 @@ + .. 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. + +Building documentation +====================== + +Airflow uses Sphinx to build the documentation. As of Airflow 3 when we split +the distributions into multiple packages, and moved the documentation to inside those +distribution building the documentation is way easier than it was on Airflow 2 and you +can usually iterate on documentation way faster, including automatically refreshing the +documentation in your browser when using ``sphinx-autobuild``. + +The current distributions we have that have sphinx-buildable documentation are: + +Documentation in separate distributions: + +* ``airflow-core/docs`` - documentation for Airflow Core +* ``providers/**/docs`` - documentation for Providers +* ``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: Review Comment: ```suggestion Documentation for general overview and summaries not connected with any specific distribution: ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
