Use Poetry for dependencies management of docs script

Poetry is already in use for the integration testing code, so it makes sense to use it with all Python code in the
repository.

Author: per1234

.github/workflows/check-links.yml

@@ -50,10 +50,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
 
-      - name: Install Python dependencies
+      - name: Install Poetry
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --requirement "${{ env.DOCUMENTATION_REQUIREMENTS_PATH }}"
+          python -m pip install poetry
 
       - name: Build documentation website
         # Ensure the documentation can build. These docs won't be published.

.github/workflows/publish-docs.yml

@@ -37,9 +37,6 @@ jobs:
     needs: publish-determination
     if: needs.publish-determination.outputs.result == 'true'
 
-    env:
-      DOCUMENTATION_REQUIREMENTS_PATH: ./docs/requirements_docs.txt
-
     steps:
       - name: Checkout local repository
         uses: actions/checkout@v2
@@ -64,14 +61,17 @@ jobs:
         uses: actions/cache@v2
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles(env.DOCUMENTATION_REQUIREMENTS_PATH) }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('./pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
-      - name: Install Python dependencies
+      - name: Install Poetry
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --requirement "${{ env.DOCUMENTATION_REQUIREMENTS_PATH }}"
+          python -m pip install poetry
+
+      - name: Install Python dependencies
+        run: poetry install --no-root
 
       - name: Publish documentation
         # Determine docs version for the commit pushed and publish accordingly using Mike.
@@ -80,4 +80,4 @@ jobs:
           git config --global user.email "bot@arduino.cc"
           git config --global user.name "ArduinoBot"
           git fetch --no-tags --prune --depth=1 origin +refs/heads/gh-pages:refs/remotes/origin/gh-pages
-          python docs/build.py
+          poetry run python docs/build.py

.github/workflows/validate-docs.yml

@@ -23,9 +23,6 @@ jobs:
   validate:
     runs-on: ubuntu-latest
 
-    env:
-      DOCUMENTATION_REQUIREMENTS_PATH: ./docs/requirements_docs.txt
-
     steps:
       - name: Checkout local repository
         uses: actions/checkout@v2
@@ -50,14 +47,14 @@ jobs:
         uses: actions/cache@v2
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles(env.DOCUMENTATION_REQUIREMENTS_PATH) }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('./pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
-      - name: Install Python dependencies
+      - name: Install Poetry
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --requirement "${{ env.DOCUMENTATION_REQUIREMENTS_PATH }}"
+          python -m pip install poetry
 
       - name: Build documentation website
         # Ensure the documentation can build. These docs won't be published.

Taskfile.yml

@@ -131,19 +131,20 @@ tasks:
     desc: Build documentation website contents
     cmds:
       - task: docs:gen
-      - mkdocs build --strict
+      - poetry install --no-root
+      - poetry run mkdocs build --strict
 
   docs:publish:
     desc: Use Mike to build and push versioned docs
     cmds:
       - task: docs:gen
-      - mike deploy --update-aliases --push --remote {{.DOCS_REMOTE}} {{.DOCS_VERSION}} {{.DOCS_ALIAS}}
+      - poetry run mike deploy --update-aliases --push --remote {{.DOCS_REMOTE}} {{.DOCS_VERSION}} {{.DOCS_ALIAS}}
 
   docs:serve:
     desc: Run documentation website locally
     cmds:
       - task: docs:build
-      - mkdocs serve
+      - poetry run mkdocs serve
 
   docs:check:
     desc: Lint and check formatting of documentation files

docs/CONTRIBUTING.md

@@ -78,9 +78,10 @@ To build arduino-lint from sources you need the following tools to be available
 - [Go](https://golang.org/doc/install) version 1.14 or later
 - [Taskfile](https://taskfile.dev/#/installation) to help you run the most common tasks from the command line
 
-If you want to run integration tests you will also need:
+If you want to run integration tests or work on documentation, you will also need:
 
-- A working [Python](https://www.python.org/downloads/) environment, version 3.8 or later
+- A working [Python](https://www.python.org/downloads/) environment, version 3.8 or later.
+- [Poetry](https://python-poetry.org/docs/).
 
 ### Building the source code
 
@@ -146,22 +147,6 @@ input and providing the expected output and proper exit codes.
 For these reasons, in addition to regular unit tests the project has a suite of integration tests that actually run
 arduino-lint in a different process and assess the options are correctly understood and the output is what we expect.
 
-##### Software requirements for running integration tests:
-
-A working Python environment. Chances are that you already have Python installed in your system, if this is not the case
-you can [download](https://www.python.org/downloads/) the official distribution or use the package manager provided by
-your Operating System.
-
-Some dependencies need to be installed before running the tests. To avoid polluting your global Python environment with
-dependencies that might be only used by the arduino-lint integration tests, we use [Poetry](https://python-poetry.org/).
-First you need to install it (you might need to `sudo` the following command):
-
-```
-pip3 install --user poetry
-```
-
-For more Poetry installation options read the [official documentation](https://python-poetry.org/docs/).
-
 ##### Running tests
 
 After the software requirements have been installed, you should be able to run the tests with:
@@ -242,16 +227,8 @@ The documentation consists of static content written over several Markdown files
 arduino-lint repository, as well as the dynamically generated [command line reference](commands/arduino-lint.md).
 
 When working on the documentation, it is useful to be able to see the effect the changes will have on the generated
-documentation website. You can build the documentation website and serve it from your personal computer.
-
-Before running the toolchain, run the following command from the root of the Git repository (if you have a Python
-virtual environment, activate it before proceeding):
-
-```
-pip install -r docs/requirements_docs.txt
-```
-
-Now run the command:
+documentation website. You can build the documentation website and serve it from your personal computer by running the
+command:
 
 ```
 task docs:serve