-
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.
edits: reverted changes and readded contributing file in docs repo
- Loading branch information
1 parent
4e36f59
commit 49c2a1e
Showing
1 changed file
with
31 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,31 @@ | ||
# Documentation Setup | ||
|
||
## Prerequisites | ||
|
||
Make sure that you have pipenv installed on your system: | ||
|
||
pip3 install pipenv | ||
|
||
Once installed navigate to this folder in the project | ||
|
||
cd fetchd/docs | ||
|
||
Make sure all the dependencies are installed | ||
|
||
pipenv install -d | ||
|
||
## Updating the docs | ||
|
||
Once the dependencies are setup you must activate the environment with the following commands | ||
|
||
pipenv shell | ||
|
||
This step should update your terminal prompt and you will be able to see that the command `mkdocs` is installed in your path | ||
|
||
which mkdocs | ||
|
||
Finally, to start the development server run the following command | ||
|
||
mkdocs serve | ||
|
||
This will listen for changes on the filesystem and automatically update the documentation. |