Skip to main content

A disnake extension that adds a docs command.

Project description

Python versions


About


This extension's purpose is of adding a "docs" command, its purpose is to help documenting in chat.

How To Load It


from disnake.ext import commands

bot = commands.Bot(...)
bot.load_extension('docs')

bot.run(...)

How To Add More Items


To add more items besides python and disnake, you can subclass doc.cog.Docs Example:

from disnake.ext import commands
from docs import cog


class MyCog(cog.Docs):
    def __init__(self, bot):
        super().__init__(bot)
        # Now we set the new items
        # NOTE: It must be a list of tuples or a tuples of tuples
        self.items = (
            ('disnake', 'https://disnake.readthedocs.io/en/latest/'),
            ('python', 'https://docs.python.org/3/'),
            ('aiohttp', 'https://aiohttp.readthedocs.io/en/stable/'),
        )
        # NOTE: You must also add `disnake` and `python` manually, otherwise
        # it will only show the items you put.


bot = commands.Bot(...)
bot.add_cog(MyCog(bot))

bot.run(...)

Inspired By


python-discord/bot/bot/exts/info/doc - The community bot for the Python Discord community

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

disnake-docs-1.2.2.tar.gz (33.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page