Skip to content

Commit

Permalink
Fix docs build errors for Sphinx 5 (apache#24870)
Browse files Browse the repository at this point in the history
Sphinx 5 is a little bit more picky about docuementation link
errors that Sphinx 4 had. Due to lack of job dependency (fixed now
via apache#24866), we accidentally upgraded to Sphinx 5 in constraints
and it started to fail our builds. Fortunately the errors in docs
are very few and we can easily fix it without reverting the
constraint change.
  • Loading branch information
potiuk authored Jul 6, 2022
1 parent b7f60d3 commit 6476afd
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ system data. HDFS is now an Apache Hadoop sub project.
Prerequisite
------------

To use operators, you must configure a :doc:`HDFS Connection <connections>`.
To use operators, you must configure a :doc:`HDFS Connection </connections>`.

.. _howto/operator:HdfsFolderSensor:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This page contains the list of all the provider configurations that you
can set in ``airflow.cfg`` file or using environment variables.

.. note::
For more information on setting the configuration, see :doc:`howto/set-config`
For more information on setting the configuration, see :doc:`apache-airflow:howto/set-config`

.. contents:: Sections:
:local:
Expand Down
2 changes: 1 addition & 1 deletion docs/apache-airflow-providers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ Exposing customized functionality to the Airflow's core:

When your providers are installed you can query the installed providers and their capabilities with the
``airflow providers`` command. This way you can verify if your providers are properly recognized and whether
they define the extensions properly. See :doc:`cli-and-env-variables-ref` for details of available CLI
they define the extensions properly. See :doc:`apache-airflow:cli-and-env-variables-ref` for details of available CLI
sub-commands.

When you write your own provider, consider following the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
Operators and Hooks Reference
=============================

Here is a list of operators and hooks that are released independently of the Airflow core. A list of core operators is available in the documentation for ``apache-airflow``: :doc:`Core Operators and Hooks Reference <operators-and-hooks-ref>`.
Here is a list of operators and hooks that are released independently of the Airflow core. A list of core operators is available in the documentation for ``apache-airflow``: :doc:`Core Operators and Hooks Reference <apache-airflow:operators-and-hooks-ref>`.

.. toctree::
:maxdepth: 3
Expand Down
4 changes: 2 additions & 2 deletions docs/docker-stack/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Those are "reference" regular images. They contain the most common set of extras
often used by the users and they are good to "try-things-out" when you want to just take Airflow for a spin,

You can also use "slim" images that contain only core airflow and are about half the size of the "regular" images
but you need to add all the :doc:`extra-packages-ref` and providers that you need separately
but you need to add all the :doc:`apache-airflow:extra-packages-ref` and providers that you need separately
via :ref:`Building the image <build:build_image>`.

* :subst-code:`apache/airflow:slim-latest` - the latest released Airflow image with default Python version (3.7 currently)
Expand All @@ -69,7 +69,7 @@ via :ref:`Building the image <build:build_image>`.

The Apache Airflow image provided as convenience package is optimized for size, and
it provides just a bare minimal set of the extras and dependencies installed and in most cases
you want to either extend or customize the image. You can see all possible extras in :doc:`extra-packages-ref`.
you want to either extend or customize the image. You can see all possible extras in :doc:`apache-airflow:extra-packages-ref`.
The set of extras used in Airflow Production image are available in the
`Dockerfile <https://github.com/apache/airflow/blob/2c6c7fdb2308de98e142618836bdf414df9768c8/Dockerfile#L37>`_.

Expand Down

0 comments on commit 6476afd

Please sign in to comment.