updates docs

Author: saxix

.github/workflows/docs.yml

@@ -0,0 +1,89 @@
+name: "Documentation"
+
+on:
+  push:
+    branches:
+      - develop
+      - master
+  schedule:
+    - cron: "37 23 * * 2"
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  #  changes:
+  #    runs-on: ubuntu-latest
+  #    timeout-minutes: 1
+  #    defaults:
+  #      run:
+  #        shell: bash
+  #    outputs:
+  #      docs: ${{ steps.changed_files.outputs.docs }}
+  #    steps:
+  #      - name: Checkout code
+  #        uses: actions/[email protected]
+  #      - id: changed_files
+  #        name: Check for file changes
+  #        uses: dorny/paths-filter@0bc4621a3135347011ad047f9ecf449bf72ce2bd # v3.0.0
+  #        with:
+  #          base: ${{ github.ref }}
+  #          token: ${{ github.token }}
+  #          filters: .github/file-filters.yml
+  generate:
+    name: Generate
+    #    if: needs.changes.outputs.docs == 'true'
+    #    needs: changes
+    runs-on: ubuntu-latest
+    env:
+      PYTHONPATH: src/
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - uses: yezz123/setup-uv@v4
+
+      - uses: actions/cache/restore@v4
+        id: restore-cache
+        with:
+          path: .venv
+          key: ${{ runner.os }}-${{ hashFiles('**/uv.lock') }}
+
+      - name: Install dependencies
+        run: uv sync --only-group docs
+
+      - name: Build Doc
+        run: .venv/bin/mkdocs build -d ./docs-output
+
+      - uses: actions/cache/save@v4
+        id: cache
+        if: always() && steps.restore-cache.outputs.cache-hit != 'true'
+        with:
+          path: .venv
+          key: ${{ runner.os }}-${{ hashFiles('**/uv.lock') }}
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs-output
+
+  # Deployment job
+  deploy:
+    needs: generate
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -7,6 +7,7 @@ build
 __pycache__
 docs/_build
 /src/pytest_echo/version.py
+!docs/src/.pages
 !.gitignore
 !.github
 !.coveragerc

.readthedocs.yaml

@@ -6,7 +6,7 @@ versions](https://img.shields.io/pypi/pyversions/pytest-echo.svg)](https://pypi.
 [![tests](https://github.com/pytest-dev/pytest-echo/actions/workflows/tests.yml/badge.svg)](https://github.com/pytest-dev/pytest-echo/actions/workflows/tests.yml)
 [![Downloads](https://static.pepy.tech/badge/pytest-echo/month)](https://pepy.tech/project/pytest-echo)
 [![Coverage](https://codecov.io/gh/pytest-dev/pytest-echo/branch/develop/graph/badge.svg)](https://codecov.io/gh/pytest-dev/pytest-echo)
-[![Documentation](https://readthedocs.org/projects/pytest-echo/badge/?version=latest)](https://pytest-echo.readthedocs.io/en/latest/)
+[![Documentation](https://github.com/pytest-dev/pytest-echo/actions/workflows/docs.yml/badge.svg)](https://github.com/pytest-dev/pytest-echo/)
 
 Print environment variables, package version and generic attributes,
 as they are at the beginning of the test.
@@ -15,15 +15,15 @@ Useful in the continuous integration to dump test
 configuration/environment and or to check if attributes are properly set
 (ie. you change environment with `os.environ`)
 
-# Install
+## Install
 
 install via::
 
     pip install pytest-echo
 
-# Examples
+## Examples
 
-## Dump environment variables
+### Dump environment variables
 
     $ pytest --echo-env=HOME
     ============================= test session starts =========================
@@ -32,7 +32,7 @@ install via::
         HOME: /Users/sax
     plugins: echo, pydev, cov, cache, django
 
-## Dump package version
+### Dump package version
 
     $ pytest --echo-version=pytest_echo
     ============================= test session starts =========================
@@ -48,7 +48,7 @@ install via::
 > level code is executed. This should be not an issue as no problematic code
 > should be present in the first level of the package
 
-## Dump attributes
+### Dump attributes
 
     $ pytest --echo-attr=django.conf.settings.DEBUG
     ============================= test session starts =========================
@@ -63,7 +63,7 @@ install via::
 
 > [!NOTE] You cannot dump callable result.
 
-## Configure via tox.ini/setup.cfg/pytest.cfg
+### Configure via tox.ini/setup.cfg/pytest.cfg
 
 Example of use in a django project:
 
@@ -100,7 +100,7 @@ Example of use in a django project:
     .............
     14 passed in 4.95 seconds
 
-## Globbing
+### Globbing
 
 Starting from version 1.5, is possible to glob packages version and environment variables,
 as: