Skip to content

Commit b6b607e

Browse files
shenxianpeng2bndy5
andauthored
docs: update steps in docs readme (#360)
* docs: update docs readme steps * fix: Update docs/README.rst Co-authored-by: Brendan <2bndy5@gmail.com> --------- Co-authored-by: Brendan <2bndy5@gmail.com>
1 parent b7fbdde commit b6b607e

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/README.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
11
How to build the docs
22
=====================
33

4-
From the root directory of the repository, do the following to steps
4+
From the root directory of the repository, do the following in steps
55

66
1. Install docs' dependencies
77

88
.. code-block:: text
99
10-
pip install -r docs/requirements.txt
10+
pip install --group 'docs'
1111
12-
On Linux, you may need to use `pip3` instead.
1312
1413
2. Build the docs
1514

1615
.. code-block:: text
1716
1817
mkdocs build
1918
20-
or use the following command to see changes rendered in realtime.
19+
Or use the following command to see changes rendered in real-time.
2120

2221
.. code-block:: text
2322

0 commit comments

Comments
 (0)