...
Expand | ||
---|---|---|
| ||
|
...
Testing .readthedocs.yml Changes
Push your changes up to Github GitHub on your PR branch.
Follow the directions from the
Go to the build output
section to go to your repos ReadTheDocs project page.Go to the
Builds
page for your project and build the latest version of the docs. (This will pull all the latest code including any new branches).Go to the
Versions
page for your project.Under the
Activate a Version
section, find the name of your PR branch.Click
Activate
on your PR branch.Set your branch to be active (it will be built) and hidden (it won’t be listed in the versions list) and then save the changes.
Now you should be able to run builds of your branch to test any changes you’re making to the
.readthedocs.yml
file.Go back to the
Builds
screen and build your branch as many times as you need while you iterate on changes.When you’re done testing, de-activate your branch on the
Versions
page.
...
If RTD is trying to build the docs using an older version of Python (2.x) you can update that version.
If your repo has a .readthedocssreadthedocs.yml
, update the python Python version in that file and push up a new PR.
...
If you see a ‘No such file or directory’ message on the requirements file, the issue might be with the config in your repo.
If your repo has a .readthedocssreadthedocs.yml
, ensure that the correct path to the requirements file is in there.
...