Merge main into 9.0 : documentation

.github/workflows/documentation.yml

@@ -0,0 +1,65 @@
+name: Deploy documentation
+
+on:
+  push:
+    branches:
+      - main
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build documentation website with MkDocs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install poetry
+        run: pip install -U poetry
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: poetry install --no-root
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+
+      - name: Build with mkdocs
+        run: poetry run mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site
+
+  deploy:
+    name: Deploy to GitHub Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -4,3 +4,4 @@ vendor/
 .phpunit.result.cache
 tests/cache/
 tools/phpstan/cache/
+site/

docs/_nav.md

@@ -0,0 +1,3 @@
+- [Quick start](index.md)
+- [With Symfony](symfony.md)
+- [Contributing](contributing.md)

docs/overrides/main.html

@@ -0,0 +1,11 @@
+{% extends "base.html" %}
+
+{% block htmltitle %}
+    {% if page.meta and page.meta.title %}
+        <title>{{ page.meta.title }} - AutoMapper</title>
+    {% elif page.title and not page.is_homepage %}
+        <title>{{ page.title | striptags }} - AutoMapper</title>
+    {% else %}
+        <title>{{ config.site_name }}</title>
+    {% endif %}
+{% endblock %}

mkdocs.yaml

@@ -0,0 +1,89 @@
+site_name: AutoMapper with on the fly code generation
+site_url: https://automapper.jolicode.com/
+repo_url: https://github.com/jolicode/automapper
+copyright: 'AutoMapper is licensed under <a href="https://github.com/jolicode/automapper/blob/main/LICENSE">MIT license</a>'
+
+edit_uri: edit/main/docs/
+docs_dir: docs
+exclude_docs: |
+  doc/_nav.md
+theme:
+  name: material
+  logo: assets/favicon.png
+  favicon: assets/favicon.png
+  icon:
+    repo: fontawesome/brands/github
+  language: en
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      scheme: default
+      primary: white
+      accent: amber
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: white
+      accent: amber
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      accent: amber
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+  features:
+    - content.action.edit
+    - content.code.copy
+    - content.tabs.link
+    - navigation.footer
+    - navigation.indexes
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.tabs
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - toc.integrate
+  custom_dir: docs/overrides
+
+extra:
+  social:
+    - icon: fontawesome/brands/github-alt
+      link: https://github.com/jolicode/automapper
+    - icon: fontawesome/brands/x-twitter
+      link: https://twitter.com/jolicode
+  generator: false
+
+markdown_extensions:
+  - admonition
+  - attr_list
+  - github-callouts
+  - footnotes
+  - pymdownx.details
+  - pymdownx.highlight:
+      use_pygments: false
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - toc:
+      permalink: true
+
+plugins:
+  - search
+  - literate-nav:
+      nav_file: _nav.md
+
+extra_javascript:
+  - assets/javascripts/highlight.min.js
+extra_css:
+  - assets/stylesheets/highlight-github.min.css