diff --git a/.vscode/launch.json b/.vscode/launch.json index b6e68446..5afe8e24 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -10,6 +10,16 @@ "name": "Launch Chrome against localhost", "url": "http://localhost:8080", "webRoot": "${workspaceFolder}" + }, + { + "name": "Test docs locally with mkdocs", + "type": "debugpy", + "request": "launch", + "program": "${workspaceFolder}/docs/env/Scripts/mkdocs.exe", + "args": ["serve", "--dev-addr", "127.0.0.1:8010"], + "cwd": "${workspaceFolder}/docs", + "console": "integratedTerminal", + "preLaunchTask": "Start MkDocs Server" } ] } \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 00000000..f50a9726 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,60 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Setup Python Environment", + "type": "shell", + "command": "python", + "args": ["-m", "venv", "env"], + "options": { + "cwd": "${workspaceFolder}/docs" + }, + "group": "build", + "presentation": { + "echo": true, + "reveal": "always", + "focus": false, + "panel": "shared" + }, + "problemMatcher": [] + }, + { + "label": "Install MkDocs Requirements", + "type": "shell", + "command": ".\\env\\Scripts\\activate.ps1; python -m pip install --upgrade pip; pip install -r requirements.txt", + "options": { + "cwd": "${workspaceFolder}/docs" + }, + "group": "build", + "presentation": { + "echo": true, + "reveal": "always", + "focus": false, + "panel": "shared" + }, + "problemMatcher": [], + "dependsOn": "Setup Python Environment" + }, + { + "label": "Start MkDocs Server", + "type": "shell", + "command": ".\\env\\Scripts\\activate.ps1; Start-Process http://localhost:8010; mkdocs serve", + "options": { + "cwd": "${workspaceFolder}/docs" + }, + "group": { + "kind": "build", + "isDefault": true + }, + "presentation": { + "echo": true, + "reveal": "always", + "focus": false, + "panel": "shared" + }, + "problemMatcher": [], + "isBackground": true, + "dependsOn": "Install MkDocs Requirements" + } + ] +} diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..a4bd1b6f --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +mkdocs>=1.5.0 +mkdocs-material>=9.0.0 +mkdocs-print-site-plugin>=2.3.0