update doc

Author: Remi-Gau

docs/source/architecture.md

@@ -0,0 +1,20 @@
+# architecture
+
+<!-- https://mermaid-js.github.io/mermaid/#/ -->
+
+```{mermaid}
+    classDiagram
+        SchemaUtils <|-- UI
+        SchemaBase  *--  UI
+        SchemaBase  <|--  Protocol
+        SchemaBase  <|--  Activity
+        SchemaUtils <|-- Message
+        SchemaBase  <|--  Item
+        Item  *--  ResponseOption
+        SchemaUtils <|-- ResponseOption
+        SchemaUtils <|-- AdditionalNoteObj
+        SchemaUtils <|-- unitOption
+        SchemaUtils <|-- Choice
+        SchemaUtils <|-- AdditionalProperty
+        SchemaUtils <|-- SchemaBase
+```

docs/source/conf.py

@@ -21,17 +21,15 @@
 author = "Repronim developers"
 
 # The full version, including alpha/beta/rc tags
-release = "0.1.0"
+release = "0.6.2"
 
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    "sphinx.ext.autodoc",
-]
+extensions = ["sphinx.ext.autodoc", "myst_parser", "sphinxcontrib.mermaid"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/source/index.rst

@@ -10,7 +10,7 @@ Welcome to reproschema-py's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-
+   architecture
 
 Indices and tables
 ==================

setup.cfg

@@ -56,6 +56,8 @@ doc =
     sphinxcontrib-apidoc ~= 0.3.0
     sphinxcontrib-napoleon
     sphinxcontrib-versioning
+    sphinxcontrib-mermaid
+    myst-parser
 docs =
     %(doc)s
 test =