Merge pull request #409 from fedejaure/feature-add-documentation

Adding basic mkdocs files

.ansible-lint

@@ -5,5 +5,6 @@ exclude_paths:
   - .cache/
   - ~/.cache/ansible-lint/
   - ~/.cache/ansible-compat/
+  - mkdocs.yml
 warn_list:
   - galaxy[version-incorrect]

.github/workflows/docs.yml

@@ -0,0 +1,66 @@
+name: docs
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+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 job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install system deps
+        shell: bash
+        run: |
+          pip install poetry
+          pip install poetry-plugin-export
+          poetry config virtualenvs.in-project true
+          poetry install --only docs --sync
+
+      - name: Build docs
+        shell: bash
+        run: poetry run inv docs
+
+      - name: Setup Pages
+        uses: actions/[email protected]
+
+      - name: Upload artifact
+        uses: actions/[email protected]
+        with:
+          # Upload entire repository
+          path: 'site/'
+
+  # Deployment job
+  deploy:
+    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/[email protected]

.pre-commit-config.yaml

@@ -10,6 +10,7 @@ repos:
       - id: check-toml
       - id: check-json
       - id: check-yaml
+        args: ['--unsafe']
       - id: debug-statements
       - id: check-merge-conflict
       - id: pretty-format-json

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
+- Docs site.
+
 - MacOS Tools/Packages:
     * Ubuntu Nerd Font.
     * Ubuntu Mono Nerd Font.

CONTRIBUTING.md

@@ -9,6 +9,7 @@ mostly guidelines, not rules. Use your best judgment, and feel free to propose c
 
 We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
 
+
 ## Getting Started
 
 ### Requirements

LICENSE.rst → LICENSE.md

@@ -1,6 +1,5 @@
 
-MIT License
-===========
+# MIT License
 
 Copyright (c) 2022, Federico Jaureguialzo