autodocs cog from https://github.com/vertyco/vrt-cogs
- Python 100%
|
|
||
|---|---|---|
| .cog-mirrorer | ||
| locales | ||
| .gitignore | ||
| __init__.py | ||
| autodocs.py | ||
| converters.py | ||
| formatter.py | ||
| info.json | ||
| LICENSE | ||
| README.md | ||
AutoDocs
Document your cogs with ease!
Easily create documentation for any cog in Markdown format.
[p]makedocs (Hybrid Command)
Create a Markdown docs page for a cog and send to discord
Arguments
cog_name: (str) The name of the cog you want to make docs for (Case Sensitive)
replace_prefix: (bool) If True, replaces the prefix placeholder with the bots prefix
replace_botname: (bool) If True, replaces the botname placeholder with the bots name
extended_info: (bool) If True, include extra info like converters and their docstrings
include_hidden: (bool) If True, includes hidden commands
include_help: (bool) If True, includes the cog help text at the top of the docs
max_privilege_level: (str) Hide commands above specified privilege level
min_privilege_level: (str) Hide commands below specified privilege level
- (user, mod, admin, guildowner, botowner)
csv_export:(bool) Include a csv with each command isolated per row for use as embeddings
Note If all is specified for cog_name, all currently loaded non-core cogs will have docs generated for
them and sent in a zip file
- Usage:
[p]makedocs <cog_name> [replace_prefix=False] [replace_botname=False] [extended_info=False] [include_hidden=False] [include_help=True] [max_privilege_level=botowner] [min_privilege_level=user] [csv_export=False] - Slash Usage:
/makedocs <cog_name> [replace_prefix=False] [replace_botname=False] [extended_info=False] [include_hidden=False] [include_help=True] [max_privilege_level=botowner] [min_privilege_level=user] [csv_export=False] - Restricted to:
BOT_OWNER - Checks:
guild_only