mirror of
https://github.com/freqtrade/freqtrade.git
synced 2024-11-10 10:21:59 +00:00
Add documentation section about running docs locally
This commit is contained in:
parent
5c5cf782f5
commit
27362046d4
|
@ -10,6 +10,15 @@ Documentation is available at [https://freqtrade.io](https://www.freqtrade.io/)
|
|||
|
||||
Special fields for the documentation (like Note boxes, ...) can be found [here](https://squidfunk.github.io/mkdocs-material/extensions/admonition/).
|
||||
|
||||
To test the documentation locally use the following commands.
|
||||
|
||||
``` bash
|
||||
pip install -r docs/requirements-docs.txt
|
||||
mkdocs serve
|
||||
```
|
||||
|
||||
This will spin up a local server (usually on port 8000) so you can see if everything looks as you'd like it to.
|
||||
|
||||
## Developer setup
|
||||
|
||||
To configure a development environment, best use the `setup.sh` script and answer "y" when asked "Do you want to install dependencies for dev [y/N]? ".
|
||||
|
|
Loading…
Reference in New Issue
Block a user