Skip to content

Commit ee730e4

Browse files
authored
Update README.md: fix docs update workflow
1 parent d4363bf commit ee730e4

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,12 +233,20 @@ as follows:
233233
git clone https://github.com/nats-io/nats.py
234234
cd nats.py
235235
git clone https://github.com/nats-io/nats.py --branch docs --single-branch docs
236+
cd docs
236237
pipenv install --dev sphinx sphinx_autodoc_typehints myst_parser furo pygments
237238
pipenv shell
238239
make html
240+
# preview the changes:
239241
make serve
240242
```
241243

244+
If you are happy with the changes, make a PR on the docs branch:
245+
```
246+
make publish
247+
git add docs
248+
```
249+
242250
## License
243251

244252
Unless otherwise noted, the NATS source files are distributed under

0 commit comments

Comments
 (0)