Skip to content

Commit

Permalink
Documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
tandemdude committed Dec 21, 2022
1 parent ab315ea commit 6f7b5e6
Show file tree
Hide file tree
Showing 21 changed files with 90 additions and 156 deletions.
31 changes: 16 additions & 15 deletions docs/source/api-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,20 @@ If you think anything is missing, make a merge request to add it, or contact tho
**Index:**

.. toctree::
:maxdepth: 2
:maxdepth: 2

api_references/app
api_references/buckets
api_references/checks
api_references/commands
api_references/context
api_references/converters
api_references/cooldowns
api_references/cooldown_algorithms
api_references/decorators
api_references/errors
api_references/events
api_references/help
api_references/plugins
api_references/utils
api_references/app
api_references/buckets
api_references/checks
api_references/commands
api_references/context
api_references/converters
api_references/cooldowns
api_references/cooldown_algorithms
api_references/decorators
api_references/errors
api_references/events
api_references/help
api_references/parser
api_references/plugins
api_references/utils
2 changes: 1 addition & 1 deletion docs/source/api_references/app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ App API Reference
=================

.. automodule:: lightbulb.app
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/buckets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Buckets API Reference
=====================

.. automodule:: lightbulb.buckets
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/checks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Checks API Reference
====================

.. automodule:: lightbulb.checks
:members:
:members:

----

Expand Down
18 changes: 9 additions & 9 deletions docs/source/api_references/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,40 @@ Base
====

.. automodule:: lightbulb.commands.base
:members:
:members:

----

Prefix Commands
===============

.. automodule:: lightbulb.commands.prefix
:members:
:show-inheritance:
:members:
:show-inheritance:

----

Slash Commands
==============

.. automodule:: lightbulb.commands.slash
:members:
:show-inheritance:
:members:
:show-inheritance:

----

Message Commands
================

.. automodule:: lightbulb.commands.message
:members:
:show-inheritance:
:members:
:show-inheritance:

----

User Commands
=============

.. automodule:: lightbulb.commands.user
:members:
:show-inheritance:
:members:
:show-inheritance:
18 changes: 9 additions & 9 deletions docs/source/api_references/context.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,40 @@ Base
====

.. automodule:: lightbulb.context.base
:members:
:members:

----

Prefix Context
==============

.. automodule:: lightbulb.context.prefix
:members:
:show-inheritance:
:members:
:show-inheritance:

----

Slash Context
=============

.. automodule:: lightbulb.context.slash
:members:
:show-inheritance:
:members:
:show-inheritance:

----

Message Context
===============

.. automodule:: lightbulb.context.message
:members:
:show-inheritance:
:members:
:show-inheritance:

----

User Context
============

.. automodule:: lightbulb.context.user
:members:
:show-inheritance:
:members:
:show-inheritance:
5 changes: 2 additions & 3 deletions docs/source/api_references/converters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@
Converters API Reference
========================


Base
====

.. automodule:: lightbulb.converters.base
:members:
:members:

----

Special
=======

.. automodule:: lightbulb.converters.special
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/cooldown_algorithms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Cooldown Algorithms API Reference
=================================

.. automodule:: lightbulb.cooldown_algorithms
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/cooldowns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Cooldowns API Reference
=======================

.. automodule:: lightbulb.cooldowns
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/decorators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Decorators API Reference
========================

.. automodule:: lightbulb.decorators
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Errors API Reference
====================

.. automodule:: lightbulb.errors
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Events API Reference
====================

.. automodule:: lightbulb.events
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Help Command API Reference
==========================

.. automodule:: lightbulb.help_command
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/parser.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Parser API Reference
====================

.. automodule:: lightbulb.parser
:members:
:members:
2 changes: 1 addition & 1 deletion docs/source/api_references/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Plugins API Reference
=====================

.. automodule:: lightbulb.plugins
:members:
:members:
10 changes: 5 additions & 5 deletions docs/source/api_references/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,36 @@ Data Store
==========

.. automodule:: lightbulb.utils.data_store
:members:
:members:

----

Nav
===

.. automodule:: lightbulb.utils.nav
:members:
:members:

----

Pag
===

.. automodule:: lightbulb.utils.pag
:members:
:members:

----

Permissions
===========

.. automodule:: lightbulb.utils.permissions
:members:
:members:

----

Search
======

.. automodule:: lightbulb.utils.search
:members:
:members:
8 changes: 4 additions & 4 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ If you think anything is missing, make a merge request to add it, or contact tho
**Index:**

.. toctree::
:maxdepth: 2
:maxdepth: 2

changelogs/v2-changelog
changelogs/v1-changelog
changelogs/v0-changelog
changelogs/v2-changelog
changelogs/v1-changelog
changelogs/v0-changelog
16 changes: 8 additions & 8 deletions docs/source/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ contact thomm.o#8637 on discord.
**Index:**

.. toctree::
:maxdepth: 2
:maxdepth: 2

guides/application-commands
guides/command-groups
guides/commands
guides/custom-help
guides/error-handling
guides/extensions
guides/plugins
guides/application-commands
guides/command-groups
guides/commands
guides/custom-help
guides/error-handling
guides/extensions
guides/plugins

0 comments on commit 6f7b5e6

Please sign in to comment.