Build the documentation for a given fork and branch - GlacioHack/xdem GitHub Wiki

If you want to build the documentation on ReadTheDocs for a work in progress in your own fork and a given branch (for example, to avoid building locally or to share with other maintainers during a PR), you should follow these steps:

1) On the first time

• Connect to your ReadTheDocs dashboard (Create an account if you don't have one).
• Select "Add Project", select "manual" and insert the GitHub URL of your fork. Name it "xdem-your_username" to avoid conflicts with the main documentation.

2) For each new branch

• In the "Versions" tab, select "Add Version", and select the branch of your fork for which you want to build the docs.
• Set it as "Active" (from now on, a documentation will be built for each commit on this branch), and also make sure to set it as "Hidden" (so that it stays private, and doesn't conflict with the main one on search engines). When clicking "Update Version", it will automatically start the build.
• You can find the build documentation and related details in the "Builds" tab, including the URL of that version ("View docs" on the right side). This URL will stay the same for this branch, even when new commits trigger new builds. You can deactivate the build when you are done testing (or it will be deactivated when the branch is deleted).