fix src-docs for packaging

canonical · Jul 10, 2024 · 36a75bc · 36a75bc
1 parent 258f013
commit 36a75bc
Show file tree

Hide file tree

Showing 35 changed files with 1,730 additions and 2,568 deletions.
diff --git a/generate-src-docs.sh b/generate-src-docs.sh
@@ -3,4 +3,4 @@
 # Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
-lazydocs --no-watermark --output-path src-docs src/*
+lazydocs --no-watermark --output-path src-docs src
diff --git a/src-docs/charm.py.md → src-docs/charm.md b/src-docs/charm.py.md → src-docs/charm.md
@@ -2,7 +2,7 @@
 
 <a href="../src/charm.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
-# <kbd>module</kbd> `charm.py`
+# <kbd>module</kbd> `charm`
 Charm for creating and managing GitHub self-hosted runner instances. 
 
 **Global Variables**
@@ -72,6 +72,19 @@ Catch common errors in actions.
 
 ---
 
+<a href="../src/charm.py#L91"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `ReconcileRunnersEvent`
+Event representing a periodic check to ensure runners are ok. 
+
+
+
+
+
+---
+
+<a href="../src/charm.py#L182"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
 ## <kbd>class</kbd> `GithubRunnerCharm`
 Charm for managing GitHub self-hosted runners. 
 
@@ -89,7 +102,7 @@ Charm for managing GitHub self-hosted runners.
 
 <a href="../src/charm.py#L205"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
-### <kbd>function</kbd> `__init__`
+### <kbd>method</kbd> `__init__`
 
 ```python
 __init__(*args: Any, **kwargs: Any) → None
@@ -150,12 +163,3 @@ Unit that this execution is responsible for.
 
 
 
----
-
-## <kbd>class</kbd> `ReconcileRunnersEvent`
-Event representing a periodic check to ensure runners are ok. 
-
-
-
-
-