Skip to content

Commit b317aef

Browse files
authored
docs: Fix missing pages and duplicate type referencing. (#1105)
* docs: Update doc utils version, update docs to account for utils architecture layout. * docs: Fix python library and utils pointer at quickstart.rst * docs: Update locale. * docs: Reduce redundancy of type references (deduplication) * docs: Update locale. * docs: Add emoji model to docs. * docs: Fix emoji header typo.
1 parent 444ab7a commit b317aef

File tree

199 files changed

+21616
-6468
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

199 files changed

+21616
-6468
lines changed

docs/api.models.emoji.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. currentmodule:: interactions
2+
3+
Emoji Models
4+
================
5+
6+
.. automodule:: interactions.api.models.emoji
7+
:members:

docs/api.models.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Model Objects
88

99
api.models.audit_log.rst
1010
api.models.channel.rst
11+
api.models.emoji.rst
1112
api.models.guild.rst
1213
api.models.gw.rst
1314
api.models.flags.rst

docs/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Interactions
2020

2121
ext.rst
2222
context.rst
23-
get.rst
23+
utils.rst
2424

2525
.. toctree::
2626
:maxdepth: 2

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737

3838
# descriptions of the relevant function/method.
3939
autodoc_typehints = "description"
40+
autodoc_typehints_description_target = "documented_params"
4041

4142
extensions = [
4243
"sphinx.ext.autodoc",

docs/get.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Ever since December 2019, this open-source project has become the culmination of
88
- Looking for a compatible library that implements all interactions?
99
- Itching to get your hands on slash commands, but in a simple manner?
1010

11-
Look no more! The goal of this library is to make all three of these questions go from possibilites to trivial matters.
11+
Look no more! The goal of this library is to make all three of these questions go from possibilities to trivial matters.
1212

1313
What can we do?
1414
***************
@@ -63,10 +63,10 @@ This open-source project utilizes the following workflows for development:
6363
#. **pre-commit** ``2.20.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
6464

6565
#. **black** ``22.6.0``
66-
#. **flake8** ``4.0.1``
66+
#. **flake8** ``5.0.4``
6767
#. **isort** ``5.10.1``
6868

69-
#. **Sphinx** ``4.4.0``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
69+
#. **Sphinx** ``5.1.1``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
7070
#. **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.
7171

7272
When can I start?

docs/locale/de/LC_MESSAGES/api.dispatch.po

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ msgid ""
99
msgstr ""
1010
"Project-Id-Version: interactions.py 4.3\n"
1111
"Report-Msgid-Bugs-To: \n"
12-
"POT-Creation-Date: 2022-07-17 16:00-0400\n"
12+
"POT-Creation-Date: 2022-09-26 12:28-0400\n"
1313
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1414
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1515
"Language-Team: LANGUAGE <LL@li.org>\n"
1616
"MIME-Version: 1.0\n"
1717
"Content-Type: text/plain; charset=utf-8\n"
1818
"Content-Transfer-Encoding: 8bit\n"
19-
"Generated-By: Babel 2.9.1\n"
19+
"Generated-By: Babel 2.10.3\n"
2020

2121
#: ../../api.dispatch.rst:4
2222
msgid "Dispatching"
@@ -38,12 +38,6 @@ msgstr ""
3838
msgid "A list of events being dispatched."
3939
msgstr ""
4040

41-
#: interactions.api.dispatch.Listener
42-
#: interactions.api.dispatch.Listener.dispatch
43-
#: interactions.api.dispatch.Listener.register of
44-
msgid "Return type"
45-
msgstr ""
46-
4741
#: interactions.api.dispatch.Listener.dispatch:1 of
4842
msgid "Dispatches an event given out by the gateway."
4943
msgstr ""
@@ -83,3 +77,6 @@ msgstr ""
8377
#: interactions.api.dispatch.Listener.register:9 of
8478
msgid "The name to associate the coroutine with. Defaults to None."
8579
msgstr ""
80+
81+
#~ msgid "Return type"
82+
#~ msgstr ""

0 commit comments

Comments
 (0)