1- #
2- # pycord documentation build configuration file, created by
3- # sphinx-quickstart on Fri Aug 21 05:43:30 2015.
4- #
5- # This file is execfile()d with the current directory set to its
6- # containing dir.
7- #
8- # Note that not all possible configuration values are present in this
9- # autogenerated file.
10- #
11- # All configuration values have a default; values that are commented out
12- # serve to show the default.
13-
141import os
152import sys
163from importlib .metadata import version as get_version
@@ -49,22 +36,12 @@ def write_new():
4936 write_new ()
5037 c_file .close ()
5138
52- # If extensions (or modules to document with autodoc) are in another directory,
53- # add these directories to sys.path here. If the directory is relative to the
54- # documentation root, use os.path.abspath to make it absolute, like shown here.
5539sys .path .insert (0 , os .path .abspath (".." ))
5640sys .path .append (os .path .abspath ("extensions" ))
5741
5842# -- General configuration ------------------------------------------------
5943
60- # If your documentation needs a minimal Sphinx version, state it here.
61- # needs_sphinx = '1.0'
62-
63- # Add any Sphinx extension module names here, as strings. They can be
64- # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
65- # ones.
6644extensions = [
67- # "builder",
6845 "sphinx.ext.autodoc" ,
6946 "sphinx.ext.autosectionlabel" ,
7047 "sphinx.ext.autosummary" ,
@@ -74,7 +51,6 @@ def write_new():
7451 "sphinx.ext.viewcode" ,
7552 "sphinx.ext.duration" ,
7653 "sphinxcontrib_trio" ,
77- # "details",
7854 "exception_hierarchy" ,
7955 "attributetable" ,
8056 "resourcelinks" ,
@@ -94,17 +70,17 @@ def write_new():
9470
9571autodoc_member_order = "bysource"
9672autodoc_typehints = "signature"
97- # Disable overload signature injection to keep docs concise
73+
74+ # Disable overload signature injection to keep docs concise. See https://github.com/Pycord-Development/pycord/pull/3124
9875typehints_document_overloads = False
99- # maybe consider this?
76+ # maybe consider this? # TODO(Paillat-dev): Consider this
10077# napoleon_attr_annotations = False
10178
10279extlinks = {
10380 "issue" : ("https://github.com/Pycord-Development/pycord/issues/%s" , "GH-%s" ),
10481 "dpy-issue" : ("https://github.com/Rapptz/discord.py/issues/%s" , "GH-%s" ),
10582}
10683
107- # Links used for cross-referencing stuff in other documentation
10884intersphinx_mapping = {
10985 "py" : ("https://docs.python.org/3" , None ),
11086 "aio" : ("https://docs.aiohttp.org/en/stable/" , None ),
@@ -121,30 +97,18 @@ def write_new():
12197.. _gateway_link: https://docs.discord.com/developers/events/gateway-events
12298"""
12399
124- # Add any paths that contain templates here, relative to this directory.
125100templates_path = ["_templates" ]
126101
127- # The suffix of source filenames.
128102source_suffix = {
129103 ".rst" : "restructuredtext" , # Used For The Other Docs
130104 ".md" : "markdown" , # Used ONLY In the Guide For Faster Making Time
131105}
132106
133- # The encoding of source files.
134- # source_encoding = 'utf-8-sig'
135-
136- # The master toctree document.
137107master_doc = "index"
138108
139- # General information about the project.
140109project = "Pycord"
141110copyright = "2015-2021, Rapptz & 2021-present, Pycord Development"
142111
143- # The version info for the project you're documenting, acts as replacement for
144- # |version| and |release|, also used in various other places throughout the
145- # built documents.
146- #
147-
148112# The full version, including alpha/beta/rc tags.
149113release = get_version ("py-cord" )
150114
@@ -160,52 +124,17 @@ def write_new():
160124
161125html_title = f"{ project } v{ version } Documentation"
162126
163- # The language for content autogenerated by Sphinx. Refer to documentation
164- # for a list of supported languages.
165- #
166- # This is also used if you do content translation via gettext catalogs.
167- # Usually you set "language" from the command line for these cases.
168127language = "en"
169128
170129gettext_compact = False
171130gettext_uuid = True
172- locale_dirs = ["locales/" ] # Added locale directory
173-
174- # There are two options for replacing |today|: either, you set today to some
175- # non-false value, then it is used:
176- # today = ''
177- # Else, today_fmt is used as the format for a strftime call.
178- # today_fmt = '%B %d, %Y'
131+ locale_dirs = ["locales/" ]
179132
180- # List of patterns, relative to source directory, that match files and
181- # directories to ignore when looking for source files.
182133exclude_patterns = ["_build" , "node_modules" , "build" , "locales" ]
183134
184- # The reST default role (used for this markup: `text`) to use for all
185- # documents.
186- # default_role = None
187-
188- # If true, '()' will be appended to :func: etc. cross-reference text.
189- # add_function_parentheses = True
190-
191- # If true, the current module name will be prepended to all description
192- # unit titles (such as .. function::).
193- # add_module_names = True
194-
195- # If true, sectionauthor and moduleauthor directives will be shown in the
196- # output. They are ignored by default.
197- # show_authors = False
198-
199135# The name of the Pygments (syntax highlighting) style to use.
200136pygments_style = "friendly"
201137
202- # A list of ignored prefixes for module index sorting.
203- # modindex_common_prefix = []
204-
205- # If true, keep warnings as "system message" paragraphs in the built documents.
206- # keep_warnings = False
207-
208-
209138# Nitpicky mode options
210139nitpick_ignore_files = [
211140 "migrating_to_v1" ,
@@ -215,10 +144,6 @@ def write_new():
215144
216145# -- Options for HTML output ----------------------------------------------
217146
218- html_experimental_html5_writer = True
219-
220- # The theme to use for HTML and HTML Help pages. See the documentation for
221- # a list of builtin themes.
222147html_theme = "furo"
223148
224149html_context = {
@@ -239,9 +164,6 @@ def write_new():
239164 "guide" : "https://guide.pycord.dev/" ,
240165}
241166
242- # Theme options are theme-specific and customize the look and feel of a theme
243- # further. For a list of options available for each theme, see the
244- # documentation.
245167base_colors = {
246168 "white" : "#ffffff" ,
247169 "grey-1" : "#f9f9fa" ,
@@ -260,7 +182,7 @@ def write_new():
260182 "blue-4" : "#003eaa" ,
261183 "blue-5" : "#002275" ,
262184 "blue-6" : "#000f40" ,
263- "blurple" : "#7289da " ,
185+ "blurple" : "#5865F2 " ,
264186}
265187
266188html_theme_options = {
@@ -303,46 +225,13 @@ def write_new():
303225 },
304226}
305227
306- # Add any paths that contain custom themes here, relative to this directory.
307- # html_theme_path = []
308-
309- # The name for this set of Sphinx documents. If None, it defaults to
310- # "<project> v<release> documentation".
311- # html_title = None
312-
313- # A shorter title for the navigation bar. Default is the same as html_title.
314- # html_short_title = None
315-
316- # The name of an image file (relative to this directory) to place at the top of
317- # the sidebar.
318228html_logo = "./images/pycord_logo.png"
319-
320- # The name of an image file (within the static path) to use as favicon of the
321- # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
322- # pixels large.
323229html_favicon = "./images/pycord.ico"
324230
325- # Add any paths that contain custom static files (such as style sheets) here,
326- # relative to this directory. They are copied after the builtin static files,
327- # so a file named "default.css" will overwrite the builtin "default.css".
328231html_static_path = ["_static" ]
329232html_css_files = ["css/custom.css" ]
330233html_js_files = ["js/custom.js" ]
331234
332- # Add any extra paths that contain custom files (such as robots.txt or
333- # .htaccess) here, relative to this directory. These files are copied
334- # directly to the root of the documentation.
335- # html_extra_path = []
336-
337- # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
338- # using the given strftime format.
339- # html_last_updated_fmt = '%b %d, %Y'
340-
341- # If true, SmartyPants will be used to convert quotes and dashes to
342- # typographically correct entities.
343- # html_use_smartypants = True
344-
345- # Custom sidebar templates, maps document names to template names.
346235html_sidebars = {
347236 "**" : [
348237 "sidebar/brand.html" ,
@@ -356,136 +245,34 @@ def write_new():
356245 ]
357246}
358247
359- # Additional templates that should be rendered to pages, maps page names to
360- # template names.
361- # html_additional_pages = {}
362-
363- # If false, no module index is generated.
364- # html_domain_indices = True
365-
366- # If false, no index is generated.
367- # html_use_index = True
368-
369- # If true, the index is split into individual pages for each letter.
370- # html_split_index = False
371-
372- # If true, links to the reST sources are added to the pages.
373- # html_show_sourcelink = True
374-
375- # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
376- # html_show_sphinx = True
377-
378- # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
379- # html_show_copyright = True
380-
381- # If true, an OpenSearch description file will be output, and all pages will
382- # contain a <link> tag referring to it. The value of this option must be the
383- # base URL from which the finished HTML is served.
384- # html_use_opensearch = ''
385-
386- # This is the file name suffix for HTML files (e.g. ".xhtml").
387- # html_file_suffix = None
388-
389- # Language to be used for generating the HTML full-text search index.
390- # Sphinx supports the following languages:
391- # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
392- # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
393248html_search_language = "en"
394249
395- # A dictionary with options for the search language support, empty by default.
396- # Now only 'ja' uses this config value
397- # html_search_options = {'type': 'default'}
398-
399- # The name of a javascript file (relative to the configuration directory) that
400- # implements a search results scorer. If empty, the default will be used.
401- # html_search_scorer = "_static/js/scorer.js"
402-
403- # html_js_files = ["custom.js", "settings.js", "copy.js", "sidebar.js"]
404-
405- # Output file base name for HTML help builder.
406250htmlhelp_basename = "pycorddoc"
407251
408252# -- Options for LaTeX output ---------------------------------------------
409253
410- latex_elements = {
411- # The paper size ('letterpaper' or 'a4paper').
412- # 'papersize': 'letterpaper',
413- # The font size ('10pt', '11pt' or '12pt').
414- # 'pointsize': '10pt',
415- # Additional stuff for the LaTeX preamble.
416- # 'preamble': '',
417- # Latex figure (float) alignment
418- # 'figure_align': 'htbp',
419- }
420-
421- # Grouping the document tree into LaTeX files. List of tuples
422- # (source start file, target name, title,
423- # author, documentclass [howto, manual, or own class]).
424254latex_documents = [
425255 ("index" , "Pycord.tex" , "Pycord Documentation" , "Pycord Development" , "manual" ),
426256]
427257
428- # The name of an image file (relative to this directory) to place at the top of
429- # the title page.
430- # latex_logo = None
431-
432- # For "manual" documents, if this is true, then toplevel headings are parts,
433- # not chapters.
434- # latex_use_parts = False
435-
436- # If true, show page references after internal links.
437- # latex_show_pagerefs = False
438-
439- # If true, show URL addresses after external links.
440- # latex_show_urls = False
441-
442- # Documents to append as an appendix to all manuals.
443- # latex_appendices = []
444-
445- # If false, no module index is generated.
446- # latex_domain_indices = True
447-
448-
449258# -- Options for manual page output ---------------------------------------
450259
451- # One entry per manual page. List of tuples
452- # (source start file, name, description, authors, manual section).
453260man_pages = [("index" , "Pycord" , "Pycord Documentation" , ["Pycord Development" ], 1 )]
454261
455- # If true, show URL addresses after external links.
456- # man_show_urls = False
457-
458-
459262# -- Options for Texinfo output -------------------------------------------
460263
461- # Grouping the document tree into Texinfo files. List of tuples
462- # (source start file, target name, title, author,
463- # dir menu entry, description, category)
464264texinfo_documents = [
465265 (
466266 "index" ,
467267 "Pycord" ,
468268 "Pycord Documentation" ,
469269 "Pycord Development" ,
470270 "Pycord" ,
471- "One line description of project ." ,
271+ "An async Discord API wrapper for Python ." ,
472272 "Miscellaneous" ,
473273 ),
474274]
475275
476- # Documents to append as an appendix to all manuals.
477- # texinfo_appendices = []
478-
479- # If false, no module index is generated.
480- # texinfo_domain_indices = True
481-
482- # How to display URL addresses: 'footnote', 'no', or 'inline'.
483- # texinfo_show_urls = 'footnote'
484-
485- # If true, do not generate a @detailmenu in the "Top" node's menu.
486- # texinfo_no_detailmenu = False
487-
488-
489276linkcheck_ignore = [
490277 r"https://docs.discord.com/developers/.*#" ,
491278 r"https://support(?:-dev)?.discord.com/hc/en-us/articles/.*" ,
0 commit comments