2022-05-16 18:48:25 -04:00
|
|
|
# This is for running mkdocs locally on windows only.
|
|
|
|
# Make sure you change directory to your docs folder before starting this process
|
2022-05-26 13:49:17 -04:00
|
|
|
# Use the "Run Selection" in VSCode to run the code blocks as-needed
|
2022-05-16 18:48:25 -04:00
|
|
|
|
|
|
|
#Activate python
|
2022-05-31 10:46:32 -04:00
|
|
|
cd docs
|
2022-05-16 18:48:25 -04:00
|
|
|
python -m venv env
|
|
|
|
.\env\Scripts\activate
|
|
|
|
|
|
|
|
#Install requirements first time only
|
2022-05-31 10:46:32 -04:00
|
|
|
python -m pip install --upgrade pip #only 1st time or use periodically to update pip modules
|
2022-05-16 18:48:25 -04:00
|
|
|
pip install pytest #only 1st time
|
|
|
|
pip install mkdocs #only 1st time
|
|
|
|
pip install mkdocs-material #only 1st time
|
|
|
|
|
|
|
|
#Run mkdocs and look at changes as you make them
|
|
|
|
mkdocs serve
|
2022-05-16 22:34:18 -04:00
|
|
|
start http://localhost:8010 #Opens Browser
|
|
|
|
|
|
|
|
#Stop python
|
|
|
|
deactivate
|