diff --git a/.gitignore b/.gitignore index efb6bef4..83a4f0bf 100644 --- a/.gitignore +++ b/.gitignore @@ -309,3 +309,7 @@ __pycache__/ *.odx.cs *.xsd.cs .DS_Store + +# When running mkdocs locally as dev +docs/__pycache__/ +docs/env/ \ No newline at end of file diff --git a/docs/startdevmkdocs.ps1 b/docs/startdevmkdocs.ps1 new file mode 100644 index 00000000..3fb3a42a --- /dev/null +++ b/docs/startdevmkdocs.ps1 @@ -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 \ No newline at end of file