Add coverage badge and documentation

github-actions[bot] · github-actions[bot] · commit 136b8fee74a1 · 2022-09-16T06:36:15.000Z
diff --git a/docs/content/grafana_dashboard_templater/dashboard.md b/docs/content/grafana_dashboard_templater/dashboard.md
@@ -33,23 +33,22 @@ The class includes all necessary methods to template the selected dashboard and
 #### get\_dashboard\_json
 
 ```python
-def get_dashboard_json(template_values: dict) -> dict
+def get_dashboard_json(template_values: Dict) -> Dict
 ```
 
-The method includes a functionality to template the selected dashboard and return the corresponding dashboard
-as dictionary
+The method includes a functionality to template the selected dashboard and return the corresponding dashboard as dictionary
 
 **Arguments**:
 
-- `template_values` _dict_ - Specify the inserted templating values as dict
+- `template_values` _Dict_ - Specify the inserted templating values as dict
   
 
 **Raises**:
 
-- `Exception` - Unspecified error by executing the functionality
+- `jinja2.TemplateNotFound` - Jinja2 template not found
   
 
 **Returns**:
 
-- `json_dashboard` _dict_ - Returns the dashboard as dict
+- `json_dashboard` _Dict_ - Returns the dashboard as dict
 
diff --git a/docs/coverage.svg b/docs/coverage.svg
@@ -9,13 +9,13 @@
     </mask>
     <g mask="url(#a)">
         <path fill="#555" d="M0 0h63v20H0z"/>
-        <path fill="#a4a61d" d="M63 0h36v20H63z"/>
+        <path fill="#4c1" d="M63 0h36v20H63z"/>
         <path fill="url(#b)" d="M0 0h99v20H0z"/>
     </g>
     <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
         <text x="31.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
         <text x="31.5" y="14">coverage</text>
-        <text x="80" y="15" fill="#010101" fill-opacity=".3">84%</text>
-        <text x="80" y="14">84%</text>
+        <text x="80" y="15" fill="#010101" fill-opacity=".3">100%</text>
+        <text x="80" y="14">100%</text>
     </g>
 </svg>
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -1,9 +1,9 @@
 docs_dir: content
 nav:
 - Home: index.md
-- Grafana Dashboard Templater Documentation:
+- Grafana Dashboard Templater:
   - Model: grafana_dashboard_templater/model.md
   - Dashboard: grafana_dashboard_templater/dashboard.md
 repo_url: https://github.com/ZPascal/grafana_dashboard_templater
 site_name: Grafana Dashboard Templater
-theme: readthedocs
+theme: material
