Skip to content

Commit 4d18c95

Browse files
Update README.md
1 parent 4d305f8 commit 4d18c95

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Python Documentation Community
22

3-
[![Documentation Status](https://readthedocs.org/projects/docs-community/badge/?version=latest)](https://docs-community.readthedocs.io/en/latest/?badge=latest)
3+
[![Documentation Status](https://readthedocs.org/projects/docs-community/badge/?version=latest)](https://docs-community.readthedocs.io/?badge=latest)
44
[![Python Discourse Documentation Category](https://img.shields.io/badge/discourse-join_chat-brightgreen.svg)](https://discuss.python.org/c/documentation/26)
55

66
<picture>
@@ -23,7 +23,7 @@
2323

2424
This repo serves as documentation for the Documentation Community Group.
2525

26-
For example, to find out more about us and what we do, [read the docs](https://docs-community.readthedocs.io/en/latest/).
26+
For example, to find out more about us and what we do, [read the docs](https://docs-community.readthedocs.io/).
2727

2828
## Build docs and view changes
2929

@@ -37,19 +37,11 @@ For example, to find out more about us and what we do, [read the docs](https://d
3737
2. Create a new Python virtual environment
3838

3939
```console
40-
python -m venv docs-wg-env
40+
make venv
4141
```
4242

43-
3. Activate the environment ([platform/shell-specific](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments))
44-
45-
4. Install dependencies
46-
47-
```console
48-
python -m pip install -r requirements.txt
49-
```
50-
51-
5. Build the docs, open them in your browser and update whenever changes are made
43+
3. Build the docs, open them in your browser and update whenever changes are made
5244

5345
```console
54-
sphinx-autobuild --open-browser docs docs/_build
46+
make html
5547
```

0 commit comments

Comments
 (0)