mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2024-11-29 07:49:39 +01:00
Make the plugin list a definition-list instead of the raw toctree
to show a short description of each plugin, instead of just the long list of names.
This commit is contained in:
parent
ab99fac88d
commit
008b183f28
@ -19,7 +19,7 @@ You should also be somewhat familiar with the
|
|||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
This document is a work in progress and is still incomplete.
|
This document is a work in progress and is still incomplete.
|
||||||
As usually, feel free to ask any questions in #limnoria @ freenode.
|
As usual, feel free to ask any questions in #limnoria @ freenode.
|
||||||
|
|
||||||
Main loop and drivers
|
Main loop and drivers
|
||||||
=====================
|
=====================
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
import importlib
|
||||||
import os
|
import os
|
||||||
import pkgutil
|
import pkgutil
|
||||||
import subprocess
|
import subprocess
|
||||||
@ -40,8 +41,25 @@ with open(os.path.join(OUTPUT_DIR, "index.rst"), "w") as fd:
|
|||||||
|
|
||||||
.. _Limnoria.net's plugin page: https://limnoria.net/plugins.xhtml
|
.. _Limnoria.net's plugin page: https://limnoria.net/plugins.xhtml
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
for plugin in plugins:
|
||||||
|
if plugin == "Alias":
|
||||||
|
# Deprecated
|
||||||
|
continue
|
||||||
|
plugin_module = importlib.import_module(f"supybot.plugins.{plugin}")
|
||||||
|
fd.write(f":doc:`{plugin} <{plugin}>`\n")
|
||||||
|
fd.write(textwrap.indent(plugin_module.__doc__, " "))
|
||||||
|
fd.write("\n")
|
||||||
|
|
||||||
|
fd.write(
|
||||||
|
textwrap.dedent(
|
||||||
|
"""
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
:hidden:
|
||||||
|
|
||||||
"""
|
"""
|
||||||
)
|
)
|
||||||
|
Loading…
Reference in New Issue
Block a user