-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds docs for running mkdocs locally (#138)
- Loading branch information
Showing
2 changed files
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Working on docs locally | ||
|
||
To work on documentation locally and preview it while developing, we can use `mkdocs serve` | ||
|
||
Start by installing the requirements for documentation. | ||
|
||
``` shell | ||
pip install -r doc-requirements.txt | ||
``` | ||
|
||
!!! tip | ||
|
||
You may want to first create a virtualenv and install requirements in there. | ||
|
||
Once the installation is done, run the mkdocs server locally to view your changes. | ||
|
||
``` shell | ||
cd genestack/ | ||
mkdocs serve | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters