Skip to content

Commit

Permalink
Review instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
ColmBhandal committed Aug 29, 2023
1 parent 39f9800 commit c3ce6b7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This Bash script does the following:
* Udates working directory paths in workflow files, and updates configuration paths in the .readthedocs.yaml file
* Deletes the cloned repository when it's done

When the script completes, your repository will have the starter sphinx documentation files added. Commit your changes.
When the script completes, your repository will have the files added that are needed to get started with Sphinx documentation. Review all changes before commiting, then commit your changes.

**Note:** When configuring RTD itself for your project, the setting **Path for
.readthedocs.yaml** (under **Advanced Settings**) will need to be given the relative path to ``.readthedocs.yaml``, including the installation directory e.g. ``docs/.readthedocs.yaml``.
Expand Down

0 comments on commit c3ce6b7

Please sign in to comment.