mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
Fix the requirements.txt file for docs/server, update README.md
This commit is contained in:
parent
8fb0682868
commit
c5fdaf24ad
@ -16,6 +16,14 @@ If you want to generate the HTML version of the long-form documentation on your
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
If you're building the *Server* docs (in `docs/server`) then you must also do:
|
||||
```bash
|
||||
pip install -e ../../
|
||||
```
|
||||
|
||||
Note: Don't put `-e ../../` in the `requirements.txt` file. That will work locally
|
||||
but not on ReadTheDocs.
|
||||
|
||||
You can then generate the HTML documentation _in that subdirectory_ by doing:
|
||||
```bash
|
||||
make html
|
||||
|
@ -4,4 +4,3 @@ sphinx-rtd-theme>=0.1.9
|
||||
sphinxcontrib-napoleon>=0.4.4
|
||||
sphinxcontrib-httpdomain>=1.5.0
|
||||
pyyaml>=3.12
|
||||
bigchaindb
|
||||
|
Loading…
x
Reference in New Issue
Block a user