Versions Compared

Old Version 3

changes.mady.by.user Feanil Patel

Saved on

compared with

New Version 4

changes.mady.by.user Ned Batchelder

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
title.readthedocs.yml for Copying
Code Block
# .readthedocs.yml                                                                                                          
# Read the Docs configuration file                                                                                           
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details                                                  
                                                                                                                             
# Required: the version of this file's schema.                                                                                                                  
version: 2                                                                                                                   
                                                                                                                             
# Build documentation in the docs/ directory with Sphinx                                                                     
sphinx:                                                                                                                      
   configuration: docs/conf.py                                                                                               
                                                                                                                             
# Optionally build your docs in additional formats such as PDF                                                               
formats:                                                                                                                     
   - pdf                                                                                                                     
   - epub                                                                                                                    
                                                                                                                             
# Optionally set the version of Python and requirements required to build your docs                                          
python:                                                                                                                      
   version: 3.8                                                                                                              
   install:                                                                                                                  
   - requirements: requirements/doc.txt

...

Testing .readthedocs.yml Changes

  1. Push your changes up to Github GitHub on your PR branch.

  2. Follow the directions from the Go to the build output section to go to your repos ReadTheDocs project page.

  3. 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).

  4. Go to the Versions page for your project.

  5. Under the Activate a Version section, find the name of your PR branch.

  6. Click Activate on your PR branch.

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

  8. Now you should be able to run builds of your branch to test any changes you’re making to the .readthedocs.yml file.

  9. Go back to the Builds screen and build your branch as many times as you need while you iterate on changes.

  10. 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.

...