Skip to content

docs: Fix typos and file naming inconsistencies in provider documentation #63683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 5 commits into from
Mar 16, 2026
Merged

docs: Fix typos and file naming inconsistencies in provider documentation #63683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
91043a0
fix typos in documentation_building.rst
Shrividya Mar 15, 2026
3e3a7a8
fix typo by renaming the pagerduty.rst file
Shrividya Mar 15, 2026
19bb649
fix double include:: for INSTALLING_PROVIDERS_FROM_SOURCES_CONTENT_RS…
Shrividya Mar 15, 2026
1734813
Merge branch 'main' into fix-typos-in-documentation
potiuk Mar 15, 2026
6990fbe
Merge branch 'main' into fix-typos-in-documentation
potiuk Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions contributing-docs/11_documentation_building.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
0 ...pagerduty/docs/connections/pagerdurty.rst → .../pagerduty/docs/connections/pagerduty.rst
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion scripts/ci/prek/check_provider_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
"""

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
"""


Expand Down
Loading