Skip to content

Commit 3d93e8b

Browse files
authored
Update README.md
1 parent 7f980e3 commit 3d93e8b

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

src/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
* The docs are built on GitHub Actions and run the ``.ci_scripts/update_docs`` script.
2-
To build the docs locally, follow the steps mentioned below:
3-
1. Clone the repository into your local machine.
4-
2. Go into the main folder.Run the following commands.
5-
3. ``conda env create -f ./.ci_scripts/environment.yml``
6-
4. ``conda activate conda-forge-docs``
7-
5. ``cd newsfeed && pip install --no-deps .``
8-
6. ``cd ../src``
9-
7. ``make html``
1+
The docs are built on GitHub Actions and run the ``.ci_scripts/update_docs`` script.
102

11-
* Once merged to ``master``, you can find the auto-generated html file in ``docs`` directory.
3+
To build the docs locally, follow the steps mentioned below:
4+
1. Clone the repository into your local machine.
5+
2. Go into the main folder.Run the following commands.
6+
3. ``conda env create -f ./.ci_scripts/environment.yml``
7+
4. ``conda activate conda-forge-docs``
8+
5. ``cd newsfeed && pip install --no-deps .``
9+
6. ``cd ../src``
10+
7. ``make html``
11+
12+
Once merged to ``master``, you can find the auto-generated html file in ``docs`` directory.
1213

0 commit comments

Comments
 (0)