Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/api.cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Client Cache

.. automodule:: interactions.api.cache
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.dispatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Dispatching

.. automodule:: interactions.api.dispatch
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.enums.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Enumerable Objects

.. automodule:: interactions.api.enums
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.error.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Error Exceptions

.. automodule:: interactions.api.error
:members:
:noindex:
3 changes: 0 additions & 3 deletions docs/api.gateway.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,9 @@ Gateway

.. automodule:: interactions.api.gateway
:members:
:noindex:

.. automodule:: interactions.api.gateway.client
:members:
:noindex:

.. automodule:: interactions.api.gateway.heartbeat
:members:
:noindex:
16 changes: 0 additions & 16 deletions docs/api.http.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,64 +5,48 @@ HTTP

.. autoclass:: interactions.api.http.route.Route
:members:
:noindex:

.. autoclass:: interactions.api.http.limiter.Limiter
:members:
:noindex:

.. autoclass:: interactions.api.http.request._Request
:members:
:noindex:

.. autoclass:: interactions.api.http.client.HTTPClient
:members:
:noindex:

.. autoclass:: interactions.api.http.channel.ChannelRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.emoji.EmojiRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.guild.GuildRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.interaction.InteractionRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.member.MemberRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.message.MessageRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.reaction.ReactionRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.scheduledEvent.ScheduledEventRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.sticker.StickerRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.thread.ThreadRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.user.UserRequest
:members:
:noindex:

.. autoclass:: interactions.api.http.webhook.WebhookRequest
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.channel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Channel Models

.. automodule:: interactions.api.models.channel
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.flags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Flag Bitshift Models

.. automodule:: interactions.api.models.flags
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.guild.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Guild Models

.. automodule:: interactions.api.models.guild
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.gw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Gateway-specific Event Models

.. automodule:: interactions.api.models.gw
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.member.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Member Models

.. automodule:: interactions.api.models.member
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.message.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Message Models

.. automodule:: interactions.api.models.message
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.misc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Miscellanous Models

.. automodule:: interactions.api.models.misc
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.presence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Presence Models

.. automodule:: interactions.api.models.presence
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.role.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Role Models

.. automodule:: interactions.api.models.role
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.team.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Team Models

.. automodule:: interactions.api.models.team
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ User Models

.. automodule:: interactions.api.models.user
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/api.models.webhook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Webhook Models

.. automodule:: interactions.api.models.webhook
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Bot Client

.. automodule:: interactions.client.bot
:members:
:noindex:
11 changes: 8 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,18 @@
autosectionlabel_prefix_document = True
hoverxref_auto_ref = True
hoverxref_sphinxtabs = True


# descriptions of the relevant function/method.
autodoc_typehints = "description"

extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.autosectionlabel",
"hoverxref.extension",
"karma_sphinx_theme",
"sphinx_search.extension",
"sphinx_copybutton",
"enum_tools.autoenum",
]

# Stackoverflow said that this is gonna cure my LaTeX errors for ref handling.
Expand Down Expand Up @@ -80,7 +85,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "karma_sphinx_theme"
html_theme = "furo"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
1 change: 0 additions & 1 deletion docs/context.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ Event Context
.. automodule:: interactions.client.context
:members:
:inherited-members:
:noindex:
1 change: 0 additions & 1 deletion docs/enums.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Enumerable Objects

.. automodule:: interactions.client.enums
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/ext.base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Core Model

.. automodule:: interactions.ext.base
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/ext.converter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Converter Model

.. automodule:: interactions.ext.converter
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/ext.error.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Error Exceptions

.. automodule:: interactions.ext.error
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/ext.version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ Versioning Models

.. automodule:: interactions.ext.version
:members:
:noindex:
1 change: 0 additions & 1 deletion docs/get.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ The ``get`` utility method

.. automodule:: interactions.client.get
:members:
:noindex:
12 changes: 5 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,13 @@ Please read up on our `contribution requirements`_ for the project. This open-so

This open-source project utilizes the following workflows for development:

#. **pre-commit** ``2.16.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
#. **pre-commit** ``2.20.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.

#. **black** ``21.11b1``
#. **flake8** ``3.9.2``
#. **isort** ``5.9.3``
#. **black** ``22.6.0``
#. **flake8** ``4.0.1``
#. **isort** ``5.10.1``

#. **Sphinx** ``4.1.2``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
#. **colorama** ``0.4.4``: our internal logger uses a customized coloring formatter to make looking for specific conditions easier when running tests.
#. **Sphinx** ``4.4.0``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
#. **Conventional Commits** ``1.0.0``: every commit that we make to our branches use the official specification of CC 1.0.0 to make git graphs easier when improving and refining communication between code reviews, Pull Requests and commits.

When can I start?
Expand All @@ -87,7 +86,6 @@ Advanced Search

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _contribution requirements: https://github.com/interactions-py/library/blob/stable/CONTRIBUTING.rst
.. _MIT License: https://github.com/interactions-py/library/blob/stable/LICENSE
Expand Down
Loading