Doc: Add mkdocs with github pages (#145)

Author: ClausHolbechArista

.gitignore

@@ -20,3 +20,4 @@ output
 venv
 .devcontainer
 .ruff_cache
+aristaproto/site

README.md

@@ -15,7 +15,7 @@ Planned changes:
 
 ## Documentation
 
-See the [documentation](aristaproto/docs/index.md)
+See the [documentation](https://aristanetworks.github.io/python-aristaproto/)
 
 ## License
 

aristaproto/mkdocs.yml

@@ -0,0 +1,36 @@
+site_name: Aristaproto
+site_url: https://aristanetworks.github.io/python-aristaproto
+theme:
+  name: material
+  palette:
+    primary: deep orange
+    accent: deep orange
+
+nav:
+  - index.md
+  - Getting Started: getting-started.md
+  - Tutorial:
+    - Messages: tutorial/messages.md
+    - Clients: tutorial/clients.md
+  - API: api.md
+  - Development: development.md
+  - Protobuf Descriptors: descriptors.md
+    
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: false
+
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences

aristaproto/pyproject.toml

@@ -13,6 +13,7 @@ requires-python = ">=3.10,<4.0"
 dependencies = ["python-dateutil>=2.9.0.post0", "typing-extensions>=4.14.0"]
 
 [project.urls]
+Documentation = "https://aristanetworks.github.io/python-aristaproto"
 Repository = "https://github.com/aristanetworks/python-aristaproto"
 
 [project.optional-dependencies]

aristaproto_compiler/pyproject.toml

@@ -24,6 +24,7 @@ dependencies = [
 aristaproto = { path = "../aristaproto" }
 
 [project.urls]
+Documentation = "https://aristanetworks.github.io/python-aristaproto"
 Repository = "https://github.com/aristanetworks/python-aristaproto"
 
 [project.scripts]