Add initial sphinx docs (#120)
This commit is contained in:
20
docs/README.md
Normal file
20
docs/README.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# CacheFlow documents
|
||||
|
||||
## Build the docs
|
||||
|
||||
```bash
|
||||
# Install dependencies.
|
||||
pip -r requirements-docs.txt
|
||||
|
||||
# Build the docs.
|
||||
make clean
|
||||
make html
|
||||
```
|
||||
|
||||
## Open the docs with your brower
|
||||
|
||||
```bash
|
||||
cd build/html
|
||||
python -m http.server
|
||||
```
|
||||
Launch your browser and open localhost:8000.
|
||||
Reference in New Issue
Block a user