l.behm/bumblebee-status
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[doc] Update list of modules

Browse source
This commit is contained in:
tobi-wan-kenobi 2020-05-05 20:53:04 +02:00
parent 8f357e4402
commit 79a52c9f42
2 changed files with 383 additions and 365 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
core/config.py
View file

@ -65,16 +65,17 @@ class print_usage(argparse.Action):
basepath = os.path.abspath( basepath = os.path.abspath(
os.path.join(os.path.dirname(os.path.realpath(__file__)), "..") os.path.join(os.path.dirname(os.path.realpath(__file__)), "..")
) )
if self._format == "rst":
print("List of modules\n===============")
rst = {}
for m in all_modules(): for m in all_modules():
try: try:
module_type = "core"
filename = os.path.join(basepath, "modules", "core", "{}.py".format(m)) filename = os.path.join(basepath, "modules", "core", "{}.py".format(m))
if not os.path.exists(filename): if not os.path.exists(filename):
filename = os.path.join( filename = os.path.join(
basepath, "modules", "contrib", "{}.py".format(m) basepath, "modules", "contrib", "{}.py".format(m)
) )
module_type = "contrib"
if not os.path.exists(filename): if not os.path.exists(filename):
log.warning("module {} not found".format(m)) log.warning("module {} not found".format(m))
continue continue
@ -88,12 +89,13 @@ class print_usage(argparse.Action):
log.warning("failed to find docstring for {}".format(m)) log.warning("failed to find docstring for {}".format(m))
continue continue
if self._format == "rst": if self._format == "rst":
print("\n{}\n{}\n".format(m, "-" * len(m)))
if os.path.exists( if os.path.exists(
os.path.join(basepath, "screenshots", "{}.png".format(m)) os.path.join(basepath, "screenshots", "{}.png".format(m))
): ):
doc = "{}\n\n.. image:: ../screenshots/{}.png".format(doc, m) doc = "{}\n\n.. image:: ../screenshots/{}.png".format(doc, m)
print(doc)
rst[module_type] = rst.get(module_type, [])
rst[module_type].append({ "module": m, "content": doc })
else: else:
print( print(
textwrap.fill( textwrap.fill(
@ -115,6 +117,14 @@ class print_usage(argparse.Action):
except Exception as e: except Exception as e:
log.warning(e) log.warning(e)
if self._format == "rst":
print("List of modules\n===============")
for k in [ "core", "contrib" ]:
print("\n{}\n{}\n".format(k, "-"*len(k)))
for mod in rst[k]:
print("\n{}\n{}\n".format(mod["module"], "~"*len(mod["module"])))
print(mod["content"])
class Config(util.store.Store): class Config(util.store.Store):
def __init__(self, args): def __init__(self, args):

730
docs/modules.rst
View file

File diff suppressed because it is too large Load diff