Skip to content

Commit 372ffe8

Browse files
authored
Update README.md
1 parent 3d93e8b commit 372ffe8

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@ The docs are built on GitHub Actions and run the ``.ci_scripts/update_docs`` scr
22

33
To build the docs locally, follow the steps mentioned below:
44
1. Clone the repository into your local machine.
5-
2. Go into the main folder.Run the following commands.
5+
2. Go into the main folder and run the following commands.
66
3. ``conda env create -f ./.ci_scripts/environment.yml``
77
4. ``conda activate conda-forge-docs``
88
5. ``cd newsfeed && pip install --no-deps .``
99
6. ``cd ../src``
1010
7. ``make html``
1111

12-
Once merged to ``master``, you can find the auto-generated html file in ``docs`` directory.
12+
Documentation update PRs should only change the files in ``src``.
13+
14+
Once the PR is merged to ``master``, you can find the auto-generated html files in ``docs`` directory.
1315

0 commit comments

Comments
 (0)