58 | {#- The main navigation header #}
59 |
80 | {#- The sub-header with search and extension related selection #}
81 |
103 | {#- The sidebar component #}
104 |
117 | {#- The actual body of the contents #}
118 |
119 | {% block body %} {% endblock %}
120 |
121 | {%- block footer %}
122 |
137 | {%- endblock %}
138 |
Default:
84 | """
85 |
86 | html_static_path = ["_static"]
87 |
88 | html_search_scorer = '_static/scorer.js'
89 |
90 | html_js_files = [
91 | 'custom.js',
92 | 'settings.js',
93 | 'copy.js',
94 | 'sidebar.js'
95 | ]
96 |
97 | htmlhelp_basename = 'pycordwavedoc'
98 | html_favicon = './assets/pycord.ico'
99 | latex_documents = [
100 | ('index', 'pycord.wavelink.tex', 'Pycord.Wavelink Documentation',
101 | 'Pycord Development', 'manual'),
102 | ]
103 |
104 | man_pages = [
105 | ('index', 'pycord.wavelink', 'Pycord.Wavelink Documentation',
106 | ['Pycord Development'], 1)
107 | ]
108 |
109 | texinfo_documents = [
110 | ('index', 'pycord.wavelink', 'Pycord.Wavelink Documentation',
111 | 'Pycord Development', 'pycord.wavelink', 'One line description of project.',
112 | 'Miscellaneous'),
113 | ]
114 |
--------------------------------------------------------------------------------
/docs/ext/spotify/index.rst:
--------------------------------------------------------------------------------
1 | ``pycord.wavelink.ext.spotify`` - Extension to make working with spotify easier
2 | ================================================================================
3 |
4 | .. currentmodule:: pycord.wavelink.ext.spotify
5 |
6 | .. autoclass:: SpotifySearchType
7 | :members:
8 |
9 | .. autoclass:: SpotifyClient
10 | :members:
11 |
12 | .. autoclass:: SpotifyTrack
13 | :members:
14 |
15 | .. autoclass:: SpotifyRequestError
16 | :members:
--------------------------------------------------------------------------------
/docs/extensions/attributetable.py:
--------------------------------------------------------------------------------
1 | from sphinx.util.docutils import SphinxDirective
2 | from sphinx.locale import _
3 | from docutils import nodes
4 | from sphinx import addnodes
5 |
6 | from collections import OrderedDict, namedtuple
7 | import importlib
8 | import inspect
9 | import os
10 | import re
11 |
12 | class attributetable(nodes.General, nodes.Element):
13 | pass
14 |
15 | class attributetablecolumn(nodes.General, nodes.Element):
16 | pass
17 |
18 | class attributetabletitle(nodes.TextElement):
19 | pass
20 |
21 | class attributetableplaceholder(nodes.General, nodes.Element):
22 | pass
23 |
24 | class attributetablebadge(nodes.TextElement):
25 | pass
26 |
27 | class attributetable_item(nodes.Part, nodes.Element):
28 | pass
29 |
30 | def visit_attributetable_node(self, node):
31 | class_ = node["python-class"]
32 | self.body.append(f'
')
33 |
34 | def visit_attributetablecolumn_node(self, node):
35 | self.body.append(self.starttag(node, 'div', CLASS='py-attribute-table-column'))
36 |
37 | def visit_attributetabletitle_node(self, node):
38 | self.body.append(self.starttag(node, 'span'))
39 |
40 | def visit_attributetablebadge_node(self, node):
41 | attributes = {
42 | 'class': 'py-attribute-table-badge',
43 | 'title': node['badge-type'],
44 | }
45 | self.body.append(self.starttag(node, 'span', **attributes))
46 |
47 | def visit_attributetable_item_node(self, node):
48 | self.body.append(self.starttag(node, 'li', CLASS='py-attribute-table-entry'))
49 |
50 | def depart_attributetable_node(self, node):
51 | self.body.append('
')
52 |
53 | def depart_attributetablecolumn_node(self, node):
54 | self.body.append('
')
55 |
56 | def depart_attributetabletitle_node(self, node):
57 | self.body.append('')
58 |
59 | def depart_attributetablebadge_node(self, node):
60 | self.body.append('')
61 |
62 | def depart_attributetable_item_node(self, node):
63 | self.body.append('')
64 |
65 | _name_parser_regex = re.compile(r'(?P