Update precommit rules and doc compilation

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -4,55 +4,55 @@ title: "[BUG] <title>"
 labels: [bug, triage]
 assignees: ghiggi
 body:
-- type: checkboxes
-  attributes:
-    label: Is there an existing issue for this?
-    description: Please search to see if an issue already exists for the bug you encountered.
-    options:
-    - label: I have searched the existing issues
-      required: true
-- type: textarea
-  attributes:
-    label: Current Behavior
-    description: A concise description of what you're experiencing.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Expected Behavior
-    description: A concise description of what you expected to happen.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Steps To Reproduce
-    description: Steps to reproduce the behavior.
-    placeholder: |
-      1. In this environment...
-      2. With this config...
-      3. Run '...'
-      4. See error...
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Environment
-    description: |
-      examples:
-        - **OS**: Ubuntu 20.04
-        - **Python**: 3.8.2
-    value: |
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. In this environment...
+        2. With this config...
+        3. Run '...'
+        4. See error...
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        examples:
+          - **OS**: Ubuntu 20.04
+          - **Python**: 3.8.2
+      value: |
         - OS:
         - python:
-    render: markdown
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Anything else?
-    description: |
-      Links? References? Anything that will give us more context about the issue you are encountering!
+      render: markdown
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
 
-      Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
-  validations:
-    required: false
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/workflows/lint.yml

@@ -1,31 +1,31 @@
-name: Lint
-on: [push, pull_request, workflow_dispatch]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.8"
-
-      - name: Ruff
-        if: success() || failure()
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: ruff --all-files
-
-      - name: Black
-        if: success() || failure()
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: black --all-files --verbose
-
-      - name: Blackdoc
-        if: success() || failure()
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: blackdoc --all-files
+name: Lint
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+
+      - name: Ruff
+        if: success() || failure()
+        uses: pre-commit/[email protected]
+        with:
+          extra_args: ruff --all-files
+
+      - name: Black
+        if: success() || failure()
+        uses: pre-commit/[email protected]
+        with:
+          extra_args: black --all-files --verbose
+
+      - name: Blackdoc
+        if: success() || failure()
+        uses: pre-commit/[email protected]
+        with:
+          extra_args: blackdoc --all-files

.github/workflows/release_to_pypi.yml

@@ -1,56 +1,56 @@
-name: Package Release to PyPI
-on:
-  push:
-    tags:
-      - "v*"
-
-jobs:
-  build-n-publish:
-    name: Build and publish to PyPI
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-
-    steps:
-      - name: Checkout source
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-
-      - name: Install pypa/build
-        run: >-
-          python -m
-          pip install build
-
-      - name: Build a binary wheel
-        run: >-
-          python -m build
-
-      - name: Publish distribution to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
-
-      - name: Get Asset name
-        if: success() || failure()
-        run: |
-          export PKG=$(ls dist/ | grep tar)
-          set -- $PKG
-          echo "asset_name=$1" >> $GITHUB_ENV
-
-      - name: Create GitHub Release
-        if: success() || failure()
-        id: create_release
-        uses: softprops/action-gh-release@v2
-        with:
-          name: ${{ github.ref }}
-          tag_name: ${{ github.ref }}
-          files: |
-            dist/${{ env.asset_name }}
-          draft: false
-          prerelease: false
-          token: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+name: Package Release to PyPI
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-n-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install build
+
+      - name: Build a binary wheel
+        run: >-
+          python -m build
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Get Asset name
+        if: success() || failure()
+        run: |
+          export PKG=$(ls dist/ | grep tar)
+          set -- $PKG
+          echo "asset_name=$1" >> $GITHUB_ENV
+
+      - name: Create GitHub Release
+        if: success() || failure()
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: ${{ github.ref }}
+          tag_name: ${{ github.ref }}
+          files: |
+            dist/${{ env.asset_name }}
+          draft: false
+          prerelease: false
+          token: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token