diff --git a/.devcontainer.json b/.devcontainer.json index 0a5f693..1da397a 100644 --- a/.devcontainer.json +++ b/.devcontainer.json @@ -1,7 +1,45 @@ +// Visual Studio Code Development Container configuration file +// https://code.visualstudio.com/docs/remote/devcontainerjson-reference { - "dockerFile": "Dockerfile", - "extensions": [ - "knisterpeter.vscode-github", - "github.vscode-pull-request-github" - ] -} \ No newline at end of file + // Docker build instructions + "name": "Docker foundations", + "build": { + "dockerfile": "Dockerfile" + }, + "customizations": { + "vscode": { + // Visual Studio Code extensions + "extensions": [ + "davidanson.vscode-markdownlint", + "github.vscode-github-actions", + "github.vscode-pull-request-github", + "ms-python.flake8", + "ms-python.pylint", + "ms-python.python", + "ms-python.vscode-pylance", + "ms-azuretools.vscode-docker", + "redhat.vscode-yaml", + "streetsidesoftware.code-spell-checker" + ], + // Visual Studio Code environment configuration + "settings": { + // Set the default terminal application to bash + "#terminal.integrated.defaultProfile.linux#": "/bin/bash", + // Customize YAML formatting + "[yaml]": { + "editor.insertSpaces": true, + "editor.tabSize": 2, + "editor.autoIndent": "keep", + "editor.quickSuggestions": { + "other": true, + "comments": false, + "strings": true + } + }, + // Set Python configuration for runtime, syntax analysis, and linting + "python.analysis.useImportHeuristic": true, + "python.pythonPath": "/usr/local/bin/python3" + } + } + } +} diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 1d51eca..9f5809d 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -18,17 +18,17 @@ jobs: steps: - name: Checkout Repo - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.head.ref }} submodules: recursive - name: Set up Python3 - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: '3.x' - - uses: actions/cache@v2 + - uses: actions/cache@v3 with: path: ~/.cache/pip key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }} @@ -43,4 +43,4 @@ jobs: - name: Deploy run: | git pull - mkdocs gh-deploy \ No newline at end of file + mkdocs gh-deploy diff --git a/requirements.txt b/requirements.txt index 642f208..b1e1962 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,56 +1,80 @@ # -# This file is autogenerated by pip-compile -# To update, run: +# This file is autogenerated by pip-compile with Python 3.9 +# by the following command: # # pip-compile requirements.in # -click==8.0.1 +babel==2.14.0 + # via mkdocs-material +certifi==2023.11.17 + # via requests +charset-normalizer==3.3.2 + # via requests +click==8.1.7 # via mkdocs +colorama==0.4.6 + # via mkdocs-material ghp-import==2.1.0 # via mkdocs -importlib-metadata==5.0.0 - # via mkdocs -jinja2==3.0.1 - # via mkdocs -markdown==3.3.4 +idna==3.6 + # via requests +importlib-metadata==7.0.1 + # via + # markdown + # mkdocs +jinja2==3.1.3 + # via + # mkdocs + # mkdocs-material +markdown==3.5.2 # via # mkdocs # mkdocs-material # pymdown-extensions -markupsafe==2.0.1 - # via jinja2 +markupsafe==2.1.3 + # via + # jinja2 + # mkdocs mergedeep==1.3.4 # via mkdocs -mkdocs==1.2.3 +mkdocs==1.5.3 # via # -r requirements.in # mkdocs-material -mkdocs-material==7.1.6 - # via - # -r requirements.in - # mkdocs-material-extensions -mkdocs-material-extensions==1.0.1 +mkdocs-material==9.5.3 + # via -r requirements.in +mkdocs-material-extensions==1.3.1 # via mkdocs-material -packaging==21.3 +packaging==23.2 # via mkdocs -pygments==2.9.0 +paginate==0.5.6 # via mkdocs-material -pymdown-extensions==10.0 +pathspec==0.12.1 + # via mkdocs +platformdirs==4.1.0 + # via mkdocs +pygments==2.17.2 + # via mkdocs-material +pymdown-extensions==10.7 # via mkdocs-material -pyparsing==3.0.9 - # via packaging python-dateutil==2.8.2 # via ghp-import -pyyaml==5.4.1 +pyyaml==6.0.1 # via # mkdocs # pymdown-extensions # pyyaml-env-tag pyyaml-env-tag==0.1 # via mkdocs +regex==2023.12.25 + # via mkdocs-material +requests==2.31.0 + # via mkdocs-material six==1.16.0 # via python-dateutil -watchdog==2.1.9 +urllib3==2.1.0 + # via requests +watchdog==3.0.0 # via mkdocs -zipp==3.8.1 +zipp==3.17.0 # via importlib-metadata