diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
index 3cdc6aed..49f7b87b 100644
--- a/.idea/codeStyles/Project.xml
+++ b/.idea/codeStyles/Project.xml
@@ -24,5 +24,29 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/royalnet.iml b/.idea/royalnet.iml
index d2034fcf..0b92a2cf 100644
--- a/.idea/royalnet.iml
+++ b/.idea/royalnet.iml
@@ -9,7 +9,7 @@
-
+
diff --git a/royalnet/backpack/README.md b/royalnet/backpack/README.md
index 0121370f..7dac7b1b 100644
--- a/royalnet/backpack/README.md
+++ b/royalnet/backpack/README.md
@@ -1,3 +1,40 @@
-# `backpack`
+
+
+# `royalnet.backpack`
+
+A Pack that is imported by default by all Royalnet instances.
+
+Keep things here to a minimum!
+
+## Commands
+
+### `version`
+
+Display the current Royalnet version.
+
+### `exception`
+
+Raise an exception in the command.
+
+### `excevent`
+
+Call an event that raises an exception.
+
+## Events
+
+### `exception`
+
+## Page Stars
+
+### `/api/royalnet/version`
+
+## Exception Stars
+
+## Tables
+
+### `telegram`
+
+### `discord`
+
+### `users`
-A Pack that is imported by default by all `royalnet` instances.
diff --git a/royalnet/generate.py b/royalnet/generate.py
index 62c06b96..5462d22d 100644
--- a/royalnet/generate.py
+++ b/royalnet/generate.py
@@ -42,10 +42,15 @@ def run(config_filename, file_format):
p(line)
elif file_format == "markdown":
+ p("")
+ p("")
for pack_name in packs:
pack = packs[pack_name]
- p(f"# {pack_name}")
+ p(f"# `{pack_name}`")
p("")
+ if pack.__doc__:
+ p(f"{pack.__doc__}")
+ p("")
try:
commands = pack.available_commands
@@ -59,6 +64,9 @@ def run(config_filename, file_format):
p("")
p(f"{command.description}")
p("")
+ if command.__doc__:
+ p(f"{command.__doc__}")
+ p("")
if len(command.aliases) > 0:
p(f"> Aliases: {''.join(['`' + alias + '` ' for alias in command.aliases])}")
p("")
@@ -73,6 +81,9 @@ def run(config_filename, file_format):
for event in events:
p(f"### `{event.name}`")
p("")
+ if event.__doc__:
+ p(f"{event.__doc__}")
+ p("")
try:
page_stars = pack.available_page_stars
@@ -84,6 +95,9 @@ def run(config_filename, file_format):
for page_star in page_stars:
p(f"### `{page_star.path}`")
p("")
+ if page_star.__doc__:
+ p(f"{page_star.__doc__}")
+ p("")
try:
exc_stars = pack.available_exception_stars
@@ -95,6 +109,9 @@ def run(config_filename, file_format):
for exc_star in exc_stars:
p(f"### `{exc_star.error}`")
p("")
+ if exc_star.__doc__:
+ p(f"{exc_star.__doc__}")
+ p("")
try:
tables = pack.available_tables
@@ -107,6 +124,9 @@ def run(config_filename, file_format):
p(f"### `{table.__tablename__}`")
p("")
# TODO: list columns
+ if table.__doc__:
+ p(f"{table.__doc__}")
+ p("")
else:
raise click.ClickException("Unknown format")