Skip to content

Commit

Permalink
add comments for preserving environment_readthedocs yml file
Browse files Browse the repository at this point in the history
  • Loading branch information
niketagrawal committed Sep 30, 2024
1 parent 9ba8ca4 commit dd69802
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ build:
# directory with the docs/ directory of the latest tag.

# The pre-install step does the following:
# Download and unzip the latest tag.
# Move the current environment_readthedocs.yaml file to a temporary location.
# Remove the current docs/ folder.
# Move the docs/ folder from the latest tag to the current location.
# Move the environment_readthedocs.yaml file back to the docs/ folder.
# 1. Download and unzip the latest tag.
# 2. Move the current environment_readthedocs.yaml file to a temporary location. (Preserving the current environment_readthedocs.yaml facilitates introducing changes to the environment_readthedocs.yaml and testing them on the latest tag.)
# 3. Remove the current docs/ folder.
# 4. Move the docs/ folder from the latest tag to the current location.
# 5. Move the environment_readthedocs.yaml file back to the docs/ folder.

conda:
environment: docs/environment_readthedocs.yaml
Expand Down

0 comments on commit dd69802

Please sign in to comment.