This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new fb640dfc4ff docs: Fix typos and file naming inconsistencies in
provider documentation (#63683)
fb640dfc4ff is described below
commit fb640dfc4ff878297eb21e6f31ba31d5f743e702
Author: Shrividya Hegde <[email protected]>
AuthorDate: Mon Mar 16 07:04:26 2026 -0400
docs: Fix typos and file naming inconsistencies in provider documentation
(#63683)
* fix typos in documentation_building.rst
* fix typo by renaming the pagerduty.rst file
pagerduty.rst file was named as pagerdurty in
providers/pagerduty/docs/connections/ path.
This commit is to rename it to the consistent naming.
* fix double include:: for INSTALLING_PROVIDERS_FROM_SOURCES_CONTENT_RST in
check_provider_docs.py
---------
Co-authored-by: Jarek Potiuk <[email protected]>
---
contributing-docs/11_documentation_building.rst | 6 +++---
.../pagerduty/docs/connections/{pagerdurty.rst => pagerduty.rst} | 0
scripts/ci/prek/check_provider_docs.py | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/contributing-docs/11_documentation_building.rst
b/contributing-docs/11_documentation_building.rst
index 7ae771fd212..6188906412b 100644
--- a/contributing-docs/11_documentation_building.rst
+++ b/contributing-docs/11_documentation_building.rst
@@ -181,7 +181,7 @@ three times in order to make sure that references between
the packages are resol
Note that this will not work with ``--autobuild`` option because
the ``--autobuild`` option will only build the documentation for single
distribution at a time. You will
see an error if you try to use ``--autobuild`` with multiple distributions.
But once the "other" package
-is build, you will be able ot use ``--autobuild`` for the other package (until
you use ``--clean-build``
+is build, you will be able to use ``--autobuild`` for the other package (until
you use ``--clean-build``
option).
You can run this command in the folder of the package you want to build - if
the package needs another
@@ -228,9 +228,9 @@ all the dependencies installed that should allow to build
all documentation for
and it is independent on the host / local environment including the OS you are
using. You can always
fall-back to this method if - for some reason - your local documentation
building is failing.
-Basic command is ``breeze build-docs`` which except ``--auto-build`` has very
similar options
+Basic command is ``breeze build-docs`` which except ``--autobuild`` has very
similar options
as the ``uv run build-docs`` command.. You can also specify a number of
options like selecting which
-distribution packages you want to build and which kind of build to run
(``--doc-only`` od ``--spelling-only``)
+distribution packages you want to build and which kind of build to run
(``--doc-only`` or ``--spelling-only``)
or request to ``--clean`` the build directory before building the
documentation.
For example:
diff --git a/providers/pagerduty/docs/connections/pagerdurty.rst
b/providers/pagerduty/docs/connections/pagerduty.rst
similarity index 100%
rename from providers/pagerduty/docs/connections/pagerdurty.rst
rename to providers/pagerduty/docs/connections/pagerduty.rst
diff --git a/scripts/ci/prek/check_provider_docs.py
b/scripts/ci/prek/check_provider_docs.py
index fb41ad4c191..886b5581cd0 100755
--- a/scripts/ci/prek/check_provider_docs.py
+++ b/scripts/ci/prek/check_provider_docs.py
@@ -75,7 +75,7 @@ SECURITY_CONTENT_RST = """
"""
INSTALLING_PROVIDERS_FROM_SOURCES_CONTENT_RST = """
-.. include:: .. include::
/../../../devel-common/src/sphinx_exts/includes/installing-providers-from-sources.rst
+.. include::
/../../../devel-common/src/sphinx_exts/includes/installing-providers-from-sources.rst
"""
