Improvements to contributing docs (#3753)
This commit is contained in:
parent
2f68ac850b
commit
0b301f8095
@ -12,7 +12,9 @@ example:
|
||||
|
||||
```console
|
||||
$ python3 -m venv .venv
|
||||
$ source .venv/bin/activate
|
||||
$ source .venv/bin/activate # activation for linux and mac
|
||||
$ .venv\Scripts\activate # activation for windows
|
||||
|
||||
(.venv)$ pip install -r test_requirements.txt
|
||||
(.venv)$ pip install -e .[d]
|
||||
(.venv)$ pre-commit install
|
||||
@ -30,6 +32,9 @@ the root of the black repo:
|
||||
|
||||
# Optional Fuzz testing
|
||||
(.venv)$ tox -e fuzz
|
||||
|
||||
# Format Black itself
|
||||
(.venv)$ tox -e run_self
|
||||
```
|
||||
|
||||
### News / Changelog Requirement
|
||||
@ -62,7 +67,7 @@ If you make changes to docs, you can test they still build locally too.
|
||||
|
||||
```console
|
||||
(.venv)$ pip install -r docs/requirements.txt
|
||||
(.venv)$ pip install [-e] .[d]
|
||||
(.venv)$ pip install -e .[d]
|
||||
(.venv)$ sphinx-build -a -b html -W docs/ docs/_build/
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user