Documentation

.gitignore

@@ -14,4 +14,6 @@ dist/
 
 .deploifai/
 
+site/
+
 .DS_STORE

deploifai/mlflow/__init__.py

@@ -6,7 +6,7 @@
 @click.group()
 def mlflow():
     """
-    Initialise, manage, and deploy an ML project
+    Set-up and manage the ML FLow Integration
     """
 
 

docs/application.md

@@ -0,0 +1,4 @@
+
+::: mkdocs-click
+    :module: deploifai.application
+    :command: application

docs/auth.md

@@ -0,0 +1,4 @@
+
+::: mkdocs-click
+    :module: deploifai.auth
+    :command: auth

docs/cloud-profile.md

@@ -0,0 +1,4 @@
+
+::: mkdocs-click
+    :module: deploifai.cloud_profile
+    :command: cloud_profile

docs/dataset.md

@@ -0,0 +1,4 @@
+
+::: mkdocs-click
+    :module: deploifai.dataset
+    :command: dataset

docs/index.md

@@ -0,0 +1,7 @@
+# CLI Reference
+
+This page provides documentation for our command line tools.
+
+::: mkdocs-click
+    :module: deploifai.cli
+    :command: cli

docs/mlflow.md

@@ -0,0 +1,4 @@
+
+::: mkdocs-click
+    :module: deploifai.mlflow
+    :command: mlflow

docs/project.md

@@ -0,0 +1,4 @@
+
+::: mkdocs-click
+    :module: deploifai.project
+    :command: project

docs/server.md

@@ -0,0 +1,4 @@
+
+::: mkdocs-click
+    :module: deploifai.server
+    :command: server

docs/workspace.md

@@ -0,0 +1,4 @@
+
+::: mkdocs-click
+    :module: deploifai.workspace
+    :command: workspace

mkdocs.yml

@@ -0,0 +1,5 @@
+site_name: Deploifai CLI
+theme: readthedocs
+
+markdown_extensions:
+    - mkdocs-click

readme.md

@@ -53,3 +53,11 @@ Or, install `deploifai` cli tool in virtual environment for testing:
 ```shell
 pip install --editable . 
 ```
+
+Read the documentation of the `deploifai` cli tool in html:\
+This documentation only functions on `Python>=3.7`.\
+Installation of `mkdocs==1.3.1` and `mkdocs-click==0.8.0` required
+
+```shell
+mkdocs serve
+```