Update README.md
This commit is contained in:
parent
877cd34169
commit
2be79c5d38
@ -29,7 +29,7 @@ $ virtualenv dev_env
|
|||||||
```
|
```
|
||||||
|
|
||||||
- fish/csh:
|
- fish/csh:
|
||||||
```sh
|
```bash
|
||||||
$ source .dev_env/bin/activate.[fish|csh]
|
$ source .dev_env/bin/activate.[fish|csh]
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -41,13 +41,12 @@ $ virtualenv dev_env
|
|||||||
### Generate/Update Documentation
|
### Generate/Update Documentation
|
||||||
|
|
||||||
* Make sure `sphinx` is installed:
|
* Make sure `sphinx` is installed:
|
||||||
```
|
```bash
|
||||||
$ sphinx-[apidoc|build|autogen|quickstart] --version
|
$ sphinx-[apidoc|build|autogen|quickstart] --version
|
||||||
$ sphinx-[apidoc|build|autogen|quickstart] 7.2.x
|
$ sphinx-[apidoc|build|autogen|quickstart] 7.2.x
|
||||||
```
|
```
|
||||||
|
|
||||||
* Change directory to ./docs and run `make [html|epub|...]`. Generated docs should
|
* Change directory to ./docs and run `make [html|epub|...]`. Generated docs will appear inside `docs/source/[html|epub|...]`.
|
||||||
be placed inside `docs/source/[html|epub|...]`.
|
|
||||||
|
|
||||||
#### If you need to generate docs from scratch
|
#### If you need to generate docs from scratch
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user