Skip to content

docs: update steps in docs readme #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 26, 2025
Merged

docs: update steps in docs readme #360

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da214b0
docs: update docs readme steps
shenxianpeng Oct 26, 2025
70e40f3
fix: Update docs/README.rst
shenxianpeng Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
How to build the docs
=====================

From the root directory of the repository, do the following to steps
From the root directory of the repository, do the following in steps

1. Install docs' dependencies

.. code-block:: text

pip install -r docs/requirements.txt
pip install --group 'docs'

On Linux, you may need to use `pip3` instead.

2. Build the docs

.. code-block:: text

mkdocs build

or use the following command to see changes rendered in realtime.
Or use the following command to see changes rendered in real-time.

.. code-block:: text

Expand Down
Loading