Skip to content

Commit

Permalink
Script description
Browse files Browse the repository at this point in the history
  • Loading branch information
ColmBhandal committed Aug 29, 2023
1 parent 9cc09a3 commit 39f9800
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ Bootstrap your repository by following these steps:
* Run the script: ``./bootstrap.sh``
* Enter the installation directory when prompted. For standalone repositories, enter ".". For documentation alongside code, enter the folder where your documentation are e.g. "docs".

This Bash script does the following:

* Clones the starter pack GitHub repository
* Creates the specified installation directory if necessary
* Copies contents and workflow files from the starter pack to the installation directory
* 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.

**Note:** When configuring RTD itself for your project, the setting **Path for
Expand Down

0 comments on commit 39f9800

Please sign in to comment.