Skip to content
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.

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

Docs: hosting integrations for build.commands #9755

Closed
wants to merge 15 commits into from
Prev Previous commit
Next Next commit
Update first paragraph to mention what the page is about
humitos committed Nov 28, 2022
commit b0459fc5c2d690032115c29241490941ce1cab6c
12 changes: 7 additions & 5 deletions docs/user/guides/hosting-integrations.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
Hosting Integrations
====================

Read the Docs performs some actions by default when building documentation for its users to.
These actions integrate the documentation project with multiple hosting features Read the Docs offers.
However, when using ``build.commands`` configuration (see :doc:`build-customization`),
the build process is overriden completely and it's the user responsibility to integrate these features.
This page explains how to manually integrate these features when Read the Docs cannot do it automatically.
This page explains the manual steps required to integrate all the hosting features when overriding the build process by using ``build.commands`` configuration
(see :doc:`build-customization`).
As Read the Docs does not have control over the build process,
it cannot install and inject the required extensions to automatically integrate them.
You are encourage to read this document and understand the "behind the scenes" to integrate these features by yourself.
This can be done by running user-defined commands in the build process or by creating a doctool extensions
that execute these actions as part of the build itself.

These are all the hosting features that Read the Docs provides by default: