Browse Source

Try to get docs to build

pull/10109/head
dolfies 4 years ago
parent
commit
1f51b7b1b5
  1. 13
      docs/api.rst
  2. 28
      docs/conf.py
  3. 10
      docs/ext/commands/api.rst

13
docs/api.rst

@ -48,14 +48,6 @@ Client
.. automethod:: Client.fetch_guilds
:async-for:
AutoShardedClient
~~~~~~~~~~~~~~~~~~
.. attributetable:: AutoShardedClient
.. autoclass:: AutoShardedClient
:members:
Application Info
------------------
@ -3491,10 +3483,7 @@ Guild
.. autoclass:: Guild()
:members:
:exclude-members: fetch_members, audit_logs
.. automethod:: fetch_members
:async-for:
:exclude-members: audit_logs
.. automethod:: audit_logs
:async-for:

28
docs/conf.py

@ -79,7 +79,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = 'discord.py'
project = 'discord.py-self'
copyright = '2015-present, Rapptz'
# The version info for the project you're documenting, acts as replacement for
@ -159,7 +159,7 @@ html_experimental_html5_writer = True
html_theme = 'basic'
html_context = {
'discord_invite': 'https://discord.gg/r3sSKJJ',
'discord_invite': 'https://discord.gg/NONE',
'discord_extensions': [
('discord.ext.commands', 'ext/commands'),
('discord.ext.tasks', 'ext/tasks'),
@ -167,10 +167,10 @@ html_context = {
}
resource_links = {
'discord': 'https://discord.gg/r3sSKJJ',
'issues': 'https://github.com/Rapptz/discord.py/issues',
'discussions': 'https://github.com/Rapptz/discord.py/discussions',
'examples': f'https://github.com/Rapptz/discord.py/tree/{branch}/examples',
'discord': 'https://discord.gg/NONE',
'issues': 'https://github.com/dolfies/discord.py-self/issues',
'discussions': 'https://github.com/dolfies/discord.py-self/discussions',
'examples': f'https://github.com/dolfies/discord.py-self/tree/{branch}/examples',
}
# Theme options are theme-specific and customize the look and feel of a theme
@ -293,8 +293,8 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'discord.py.tex', 'discord.py Documentation',
'Rapptz', 'manual'),
('index', 'discord.py.tex', 'discord.py-self Documentation',
'Dolfies', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@ -323,8 +323,8 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'discord.py', 'discord.py Documentation',
['Rapptz'], 1)
('index', 'discord.py-self', 'discord.py-self Documentation',
['Dolfies'], 1)
]
# If true, show URL addresses after external links.
@ -337,8 +337,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'discord.py', 'discord.py Documentation',
'Rapptz', 'discord.py', 'One line description of project.',
('index', 'discord.py=self', 'discord.py-self Documentation',
'Dolfies', 'discord.py-self', 'One line description of project.',
'Miscellaneous'),
]
@ -357,5 +357,5 @@ texinfo_documents = [
def setup(app):
if app.config.language == 'ja':
app.config.intersphinx_mapping['py'] = ('https://docs.python.org/ja/3', None)
app.config.html_context['discord_invite'] = 'https://discord.gg/nXzj3dg'
app.config.resource_links['discord'] = 'https://discord.gg/nXzj3dg'
app.config.html_context['discord_invite'] = 'https://discord.gg/NONE'
app.config.resource_links['discord'] = 'https://discord.gg/NONE'

10
docs/ext/commands/api.rst

@ -34,7 +34,7 @@ Bot
.. automethod:: Bot.command(*args, **kwargs)
:decorator:
.. automethod:: Bot.event()
:decorator:
@ -44,14 +44,6 @@ Bot
.. automethod:: Bot.listen(name=None)
:decorator:
AutoShardedBot
~~~~~~~~~~~~~~~~
.. attributetable:: discord.ext.commands.AutoShardedBot
.. autoclass:: discord.ext.commands.AutoShardedBot
:members:
Prefix Helpers
----------------

Loading…
Cancel
Save