Merge pull request #3 from jonasnieberle/develope

implement automatic documentation

.github/workflows/mkdocs.yml

@@ -0,0 +1,17 @@
+name: mkdocs
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material mkdocs-autorefs mkdocs-material-extensions mkdocstrings mkdocstrings-python-legacy mkdocs-include-markdown-plugin
+      - run: mkdocs gh-deploy --force

docs/index.md

@@ -0,0 +1,3 @@
+{%
+    include-markdown "../README.md"
+%}

mkdocs.yml

@@ -0,0 +1,41 @@
+site_name: Cookiecutter NetBox Plugin
+site_url: https://github.com/jonasnieberle/netbox-os-manager
+repo_url: https://github.com/jonasnieberle/netbox-os-manager
+repo_name: jonasnieberle/netbox-os-manager
+nav:
+  - Introduction: index.md
+#   - Tutorial: tutorial.md
+#   - Prompts: prompts.md
+#   - Release checklist: pypi_release_checklist.md
+#   - History: history.md
+
+theme:
+  name: material
+  language: en
+  #logo: assets/logo.png
+  palette:
+      scheme: preference
+      primary: indigo
+      accent: indigo
+  features:
+    - navigation.indexes
+    - navigation.instant
+    - navigation.tabs.sticky
+
+markdown_extensions:
+  - pymdownx.highlight:
+      linenums: true
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.superfences
+  - pymdownx.details
+  - admonition
+  - toc:
+      baselevel: 2
+      permalink: true
+      slugify: !!python/name:pymdownx.slugs.uslugify
+plugins:
+  - include-markdown
+  - search:
+      lang: en