Adding mkdocs build items for running locally on windows

This commit is contained in:
silversword411 2022-05-16 18:48:25 -04:00
parent cee069d1df
commit 0ee0ba7df1
2 changed files with 20 additions and 0 deletions

4
.gitignore vendored
View File

@ -309,3 +309,7 @@ __pycache__/
*.odx.cs
*.xsd.cs
.DS_Store
# When running mkdocs locally as dev
docs/__pycache__/
docs/env/

16
docs/startdevmkdocs.ps1 Normal file
View File

@ -0,0 +1,16 @@
# This is for running mkdocs locally on windows only.
# Make sure you change directory to your docs folder before starting this process
#Activate python
python -m venv env
.\env\Scripts\activate
#Install requirements first time only
python -m pip install --upgrade pip #only 1st time
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
start http://localhost:8010 #Opens Browser