nambrogi
/
pomice
mirror of https://github.com/cloudwithax/pomice.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add sphinx_rtd_theme theme for docs

This commit is contained in:
DeadPool 2022-02-01 14:29:37 +00:00
parent c0fd4fe734
commit 0e154270b0
24 changed files with 958 additions and 1618 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_build/doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
docs/_build/doctrees/index.doctree vendored
View File

Binary file not shown.

BIN
docs/_build/doctrees/modules.doctree vendored
View File

Binary file not shown.

BIN
docs/_build/doctrees/pomice.doctree vendored
View File

Binary file not shown.

BIN
docs/_build/doctrees/pomice.spotify.doctree vendored
View File

Binary file not shown.

2
docs/_build/html/.buildinfo vendored
View File

@ -1,4 +1,4 @@
# Sphinx build info version 1 # Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0ed884b921767abe79957ecf5d5887be config: b63d0a8d2c46c67bfeda65e124ed2f92
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7

701
docs/_build/html/_static/alabaster.css vendored
View File

@ -1,701 +0,0 @@
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: Georgia, serif;
font-size: 17px;
background-color: #fff;
color: #000;
margin: 0;
padding: 0;
}
div.document {
width: 940px;
margin: 30px auto 0 auto;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 220px;
}
div.sphinxsidebar {
width: 220px;
font-size: 14px;
line-height: 1.5;
}
hr {
border: 1px solid #B1B4B6;
}
div.body {
background-color: #fff;
color: #3E4349;
padding: 0 30px 0 30px;
}
div.body > .section {
text-align: left;
}
div.footer {
width: 940px;
margin: 20px auto 30px auto;
font-size: 14px;
color: #888;
text-align: right;
}
div.footer a {
color: #888;
}
p.caption {
font-family: inherit;
font-size: inherit;
}
div.relations {
display: none;
}
div.sphinxsidebar a {
color: #444;
text-decoration: none;
border-bottom: 1px dotted #999;
}
div.sphinxsidebar a:hover {
border-bottom: 1px solid #999;
}
div.sphinxsidebarwrapper {
padding: 18px 10px;
}
div.sphinxsidebarwrapper p.logo {
padding: 0;
margin: -10px 0 0 0px;
text-align: center;
}
div.sphinxsidebarwrapper h1.logo {
margin-top: -10px;
text-align: center;
margin-bottom: 5px;
text-align: left;
}
div.sphinxsidebarwrapper h1.logo-name {
margin-top: 0px;
}
div.sphinxsidebarwrapper p.blurb {
margin-top: 0;
font-style: normal;
}
div.sphinxsidebar h3,
div.sphinxsidebar h4 {
font-family: Georgia, serif;
color: #444;
font-size: 24px;
font-weight: normal;
margin: 0 0 5px 0;
padding: 0;
}
div.sphinxsidebar h4 {
font-size: 20px;
}
div.sphinxsidebar h3 a {
color: #444;
}
div.sphinxsidebar p.logo a,
div.sphinxsidebar h3 a,
div.sphinxsidebar p.logo a:hover,
div.sphinxsidebar h3 a:hover {
border: none;
}
div.sphinxsidebar p {
color: #555;
margin: 10px 0;
}
div.sphinxsidebar ul {
margin: 10px 0;
padding: 0;
color: #000;
}
div.sphinxsidebar ul li.toctree-l1 > a {
font-size: 120%;
}
div.sphinxsidebar ul li.toctree-l2 > a {
font-size: 110%;
}
div.sphinxsidebar input {
border: 1px solid #CCC;
font-family: Georgia, serif;
font-size: 1em;
}
div.sphinxsidebar hr {
border: none;
height: 1px;
color: #AAA;
background: #AAA;
text-align: left;
margin-left: 0;
width: 50%;
}
div.sphinxsidebar .badge {
border-bottom: none;
}
div.sphinxsidebar .badge:hover {
border-bottom: none;
}
/* To address an issue with donation coming after search */
div.sphinxsidebar h3.donation {
margin-top: 10px;
}
/* -- body styles ----------------------------------------------------------- */
a {
color: #004B6B;
text-decoration: underline;
}
a:hover {
color: #6D4100;
text-decoration: underline;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: Georgia, serif;
font-weight: normal;
margin: 30px 0px 10px 0px;
padding: 0;
}
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
div.body h2 { font-size: 180%; }
div.body h3 { font-size: 150%; }
div.body h4 { font-size: 130%; }
div.body h5 { font-size: 100%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #DDD;
padding: 0 4px;
text-decoration: none;
}
a.headerlink:hover {
color: #444;
background: #EAEAEA;
}
div.body p, div.body dd, div.body li {
line-height: 1.4em;
}
div.admonition {
margin: 20px 0px;
padding: 10px 30px;
background-color: #EEE;
border: 1px solid #CCC;
}
div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
background-color: #FBFBFB;
border-bottom: 1px solid #fafafa;
}
div.admonition p.admonition-title {
font-family: Georgia, serif;
font-weight: normal;
font-size: 24px;
margin: 0 0 10px 0;
padding: 0;
line-height: 1;
}
div.admonition p.last {
margin-bottom: 0;
}
div.highlight {
background-color: #fff;
}
dt:target, .highlight {
background: #FAF3E8;
}
div.warning {
background-color: #FCC;
border: 1px solid #FAA;
}
div.danger {
background-color: #FCC;
border: 1px solid #FAA;
-moz-box-shadow: 2px 2px 4px #D52C2C;
-webkit-box-shadow: 2px 2px 4px #D52C2C;
box-shadow: 2px 2px 4px #D52C2C;
}
div.error {
background-color: #FCC;
border: 1px solid #FAA;
-moz-box-shadow: 2px 2px 4px #D52C2C;
-webkit-box-shadow: 2px 2px 4px #D52C2C;
box-shadow: 2px 2px 4px #D52C2C;
}
div.caution {
background-color: #FCC;
border: 1px solid #FAA;
}
div.attention {
background-color: #FCC;
border: 1px solid #FAA;
}
div.important {
background-color: #EEE;
border: 1px solid #CCC;
}
div.note {
background-color: #EEE;
border: 1px solid #CCC;
}
div.tip {
background-color: #EEE;
border: 1px solid #CCC;
}
div.hint {
background-color: #EEE;
border: 1px solid #CCC;
}
div.seealso {
background-color: #EEE;
border: 1px solid #CCC;
}
div.topic {
background-color: #EEE;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre, tt, code {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.9em;
}
.hll {
background-color: #FFC;
margin: 0 -12px;
padding: 0 12px;
display: block;
}
img.screenshot {
}
tt.descname, tt.descclassname, code.descname, code.descclassname {
font-size: 0.95em;
}
tt.descname, code.descname {
padding-right: 0.08em;
}
img.screenshot {
-moz-box-shadow: 2px 2px 4px #EEE;
-webkit-box-shadow: 2px 2px 4px #EEE;
box-shadow: 2px 2px 4px #EEE;
}
table.docutils {
border: 1px solid #888;
-moz-box-shadow: 2px 2px 4px #EEE;
-webkit-box-shadow: 2px 2px 4px #EEE;
box-shadow: 2px 2px 4px #EEE;
}
table.docutils td, table.docutils th {
border: 1px solid #888;
padding: 0.25em 0.7em;
}
table.field-list, table.footnote {
border: none;
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
table.footnote {
margin: 15px 0;
width: 100%;
border: 1px solid #EEE;
background: #FDFDFD;
font-size: 0.9em;
}
table.footnote + table.footnote {
margin-top: -15px;
border-top: none;
}
table.field-list th {
padding: 0 0.8em 0 0;
}
table.field-list td {
padding: 0;
}
table.field-list p {
margin-bottom: 0.8em;
}
/* Cloned from
* https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
*/
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
table.footnote td.label {
width: .1px;
padding: 0.3em 0 0.3em 0.5em;
}
table.footnote td {
padding: 0.3em 0.5em;
}
dl {
margin: 0;
padding: 0;
}
dl dd {
margin-left: 30px;
}
blockquote {
margin: 0 0 0 30px;
padding: 0;
}
ul, ol {
/* Matches the 30px from the narrow-screen "li > ul" selector below */
margin: 10px 0 10px 30px;
padding: 0;
}
pre {
background: #EEE;
padding: 7px 30px;
margin: 15px 0px;
line-height: 1.3em;
}
div.viewcode-block:target {
background: #ffd;
}
dl pre, blockquote pre, li pre {
margin-left: 0;
padding-left: 30px;
}
tt, code {
background-color: #ecf0f3;
color: #222;
/* padding: 1px 2px; */
}
tt.xref, code.xref, a tt {
background-color: #FBFBFB;
border-bottom: 1px solid #fff;
}
a.reference {
text-decoration: none;
border-bottom: 1px dotted #004B6B;
}
/* Don't put an underline on images */
a.image-reference, a.image-reference:hover {
border-bottom: none;
}
a.reference:hover {
border-bottom: 1px solid #6D4100;
}
a.footnote-reference {
text-decoration: none;
font-size: 0.7em;
vertical-align: top;
border-bottom: 1px dotted #004B6B;
}
a.footnote-reference:hover {
border-bottom: 1px solid #6D4100;
}
a:hover tt, a:hover code {
background: #EEE;
}
@media screen and (max-width: 870px) {
div.sphinxsidebar {
display: none;
}
div.document {
width: 100%;
}
div.documentwrapper {
margin-left: 0;
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
}
div.bodywrapper {
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
margin-left: 0;
}
ul {
margin-left: 0;
}
li > ul {
/* Matches the 30px from the "ul, ol" selector above */
margin-left: 30px;
}
.document {
width: auto;
}
.footer {
width: auto;
}
.bodywrapper {
margin: 0;
}
.footer {
width: auto;
}
.github {
display: none;
}
}
@media screen and (max-width: 875px) {
body {
margin: 0;
padding: 20px 30px;
}
div.documentwrapper {
float: none;
background: #fff;
}
div.sphinxsidebar {
display: block;
float: none;
width: 102.5%;
margin: 50px -30px -20px -30px;
padding: 10px 20px;
background: #333;
color: #FFF;
}
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
div.sphinxsidebar h3 a {
color: #fff;
}
div.sphinxsidebar a {
color: #AAA;
}
div.sphinxsidebar p.logo {
display: none;
}
div.document {
width: 100%;
margin: 0;
}
div.footer {
display: none;
}
div.bodywrapper {
margin: 0;
}
div.body {
min-height: 0;
padding: 0;
}
.rtd_doc_footer {
display: none;
}
.document {
width: auto;
}
.footer {
width: auto;
}
.footer {
width: auto;
}
.github {
display: none;
}
}
/* misc. */
.revsys-inline {
display: none!important;
}
/* Make nested-list/multi-paragraph items look better in Releases changelog
* pages. Without this, docutils' magical list fuckery causes inconsistent
* formatting between different release sub-lists.
*/
div#changelog > div.section > ul > li > p:only-child {
margin-bottom: 0;
}
/* Hide fugly table cell borders in ..bibliography:: directive output */
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
border: none;
/* Below needed in some edge cases; if not applied, bottom shadows appear */
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
/* relbar */
.related {
line-height: 30px;
width: 100%;
font-size: 0.9rem;
}
.related.top {
border-bottom: 1px solid #EEE;
margin-bottom: 20px;
}
.related.bottom {
border-top: 1px solid #EEE;
}
.related ul {
padding: 0;
margin: 0;
list-style: none;
}
.related li {
display: inline;
}
nav#rellinks {
float: right;
}
nav#rellinks li+li:before {
content: "|";
}
nav#breadcrumbs li+li:before {
content: "\00BB";
}
/* Hide certain items when printing */
@media print {
div.related {
display: none;
}
}

6
docs/_build/html/_static/basic.css vendored
View File

@ -4,7 +4,7 @@
* *
* Sphinx stylesheet -- basic theme. * Sphinx stylesheet -- basic theme.
* *
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details. * :license: BSD, see LICENSE for details.
* *
*/ */
@ -731,8 +731,9 @@ dl.glossary dt {
.classifier:before { .classifier:before {
font-style: normal; font-style: normal;
margin: 0.5em; margin: 0 0.5em;
content: ":"; content: ":";
display: inline-block;
} }
abbr, acronym { abbr, acronym {
@ -756,6 +757,7 @@ span.pre {
-ms-hyphens: none; -ms-hyphens: none;
-webkit-hyphens: none; -webkit-hyphens: none;
hyphens: none; hyphens: none;
white-space: nowrap;
} }
div[class*="highlight-"] { div[class*="highlight-"] {

1
docs/_build/html/_static/custom.css vendored
View File

@ -1 +0,0 @@
/* This file intentionally left blank. */

5
docs/_build/html/_static/doctools.js vendored
View File

@ -4,7 +4,7 @@
* *
* Sphinx JavaScript utilities for all documentation. * Sphinx JavaScript utilities for all documentation.
* *
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details. * :license: BSD, see LICENSE for details.
* *
*/ */
@ -264,6 +264,9 @@ var Documentation = {
hideSearchWords : function() { hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300); $('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted'); $('span.highlighted').removeClass('highlighted');
var url = new URL(window.location);
url.searchParams.delete('highlight');
window.history.replaceState({}, '', url);
}, },
/** /**

2
docs/_build/html/_static/language_data.js vendored
View File

@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js, * This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter. * namely the list of stopwords, stemmer, scorer and splitter.
* *
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details. * :license: BSD, see LICENSE for details.
* *
*/ */

138
docs/_build/html/_static/pygments.css vendored
View File

@ -5,78 +5,70 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc } .highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; } .highlight { background: #f8f8f8; }
.highlight .c { color: #8f5902; font-style: italic } /* Comment */ .highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ .highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .g { color: #000000 } /* Generic */ .highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .k { color: #004461; font-weight: bold } /* Keyword */ .highlight .o { color: #666666 } /* Operator */
.highlight .l { color: #000000 } /* Literal */ .highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
.highlight .n { color: #000000 } /* Name */ .highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
.highlight .o { color: #582800 } /* Operator */ .highlight .cp { color: #9C6500 } /* Comment.Preproc */
.highlight .x { color: #000000 } /* Other */ .highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ .highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ .highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ .highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .cp { color: #8f5902 } /* Comment.Preproc */ .highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ .highlight .gr { color: #E40000 } /* Generic.Error */
.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
.highlight .gd { color: #a40000 } /* Generic.Deleted */
.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
.highlight .gr { color: #ef2929 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */ .highlight .gi { color: #008400 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */ .highlight .go { color: #717171 } /* Generic.Output */
.highlight .gp { color: #745334 } /* Generic.Prompt */ .highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ .highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ .highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ .highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ .highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ .highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ .highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ .highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ .highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .ld { color: #000000 } /* Literal.Date */ .highlight .m { color: #666666 } /* Literal.Number */
.highlight .m { color: #990000 } /* Literal.Number */ .highlight .s { color: #BA2121 } /* Literal.String */
.highlight .s { color: #4e9a06 } /* Literal.String */ .highlight .na { color: #687822 } /* Name.Attribute */
.highlight .na { color: #c4a000 } /* Name.Attribute */ .highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nb { color: #004461 } /* Name.Builtin */ .highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .nc { color: #000000 } /* Name.Class */ .highlight .no { color: #880000 } /* Name.Constant */
.highlight .no { color: #000000 } /* Name.Constant */ .highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .nd { color: #888888 } /* Name.Decorator */ .highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
.highlight .ni { color: #ce5c00 } /* Name.Entity */ .highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0000FF } /* Name.Function */
.highlight .nf { color: #000000 } /* Name.Function */ .highlight .nl { color: #767600 } /* Name.Label */
.highlight .nl { color: #f57900 } /* Name.Label */ .highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nn { color: #000000 } /* Name.Namespace */ .highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nx { color: #000000 } /* Name.Other */ .highlight .nv { color: #19177C } /* Name.Variable */
.highlight .py { color: #000000 } /* Name.Property */ .highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .nv { color: #000000 } /* Name.Variable */ .highlight .mb { color: #666666 } /* Literal.Number.Bin */
.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ .highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ .highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .mb { color: #990000 } /* Literal.Number.Bin */ .highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .mf { color: #990000 } /* Literal.Number.Float */ .highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .mh { color: #990000 } /* Literal.Number.Hex */ .highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .mi { color: #990000 } /* Literal.Number.Integer */ .highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .mo { color: #990000 } /* Literal.Number.Oct */ .highlight .sc { color: #BA2121 } /* Literal.String.Char */
.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ .highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ .highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ .highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ .highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ .highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ .highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ .highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ .highlight .sr { color: #A45A77 } /* Literal.String.Regex */
.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ .highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ .highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ .highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ .highlight .fm { color: #0000FF } /* Name.Function.Magic */
.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ .highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ .highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .fm { color: #000000 } /* Name.Function.Magic */ .highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vc { color: #000000 } /* Name.Variable.Class */ .highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .vg { color: #000000 } /* Name.Variable.Global */ .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
.highlight .vi { color: #000000 } /* Name.Variable.Instance */
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */

7
docs/_build/html/_static/searchtools.js vendored
View File

@ -4,7 +4,7 @@
* *
* Sphinx JavaScript utilities for the full-text search. * Sphinx JavaScript utilities for the full-text search.
* *
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details. * :license: BSD, see LICENSE for details.
* *
*/ */
@ -328,7 +328,9 @@ var Search = {
var results = []; var results = [];
for (var prefix in objects) { for (var prefix in objects) {
for (var name in objects[prefix]) { for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
var match = objects[prefix][iMatch];
var name = match[4];
var fullname = (prefix ? prefix + '.' : '') + name; var fullname = (prefix ? prefix + '.' : '') + name;
var fullnameLower = fullname.toLowerCase() var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) { if (fullnameLower.indexOf(object) > -1) {
@ -342,7 +344,6 @@ var Search = {
} else if (parts[parts.length - 1].indexOf(object) > -1) { } else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch; score += Scorer.objPartialMatch;
} }
var match = objects[prefix][name];
var objname = objnames[match[1]][2]; var objname = objnames[match[1]][2];
var title = titles[match[0]]; var title = titles[match[0]];
// If more than one term searched for, we require other words to be // If more than one term searched for, we require other words to be

176
docs/_build/html/genindex.html vendored
View File

@ -1,34 +1,65 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; Pomice 1.1.1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<html> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<head> <script src="_static/jquery.js"></script>
<meta charset="utf-8" /> <script src="_static/underscore.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <script src="_static/doctools.js"></script>
<title>Index &#8212; Pomice 1.1.1 documentation</title> <script src="_static/js/theme.js"></script>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="#" /> <link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
</head>
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Pomice
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
</div>
</div>
</nav>
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Pomice</a>
</nav>
</head><body> <div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div class="document"> <ul class="wy-breadcrumbs">
<div class="documentwrapper"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<div class="bodywrapper"> <li>Index</li>
<li class="wy-breadcrumbs-aside">
</li>
<div class="body" role="main"> </ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1 id="index">Index</h1> <h1 id="index">Index</h1>
@ -75,9 +106,15 @@
<li><a href="pomice.html#pomice.pool.Node.bot">(pomice.pool.Node property)</a> <li><a href="pomice.html#pomice.pool.Node.bot">(pomice.pool.Node property)</a>
</li> </li>
</ul></li> </ul></li>
<li><a href="pomice.html#pomice.pool.Node.build_track">build_track() (pomice.pool.Node method)</a>
</li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pomice.html#pomice.pool.Node.build_track">build_track() (pomice.pool.Node method)</a> <li><a href="pomice.html#pomice.enums.NodeAlgorithm.by_ping">by_ping (pomice.enums.NodeAlgorithm attribute)</a>
</li>
<li><a href="pomice.html#pomice.enums.NodeAlgorithm.by_players">by_players (pomice.enums.NodeAlgorithm attribute)</a>
</li>
<li><a href="pomice.html#pomice.enums.NodeAlgorithm.by_region">by_region (pomice.enums.NodeAlgorithm attribute)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -155,6 +192,8 @@
<h2 id="G">G</h2> <h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pomice.html#pomice.pool.NodePool.get_best_node">get_best_node() (pomice.pool.NodePool class method)</a>
</li>
<li><a href="pomice.html#pomice.pool.NodePool.get_node">get_node() (pomice.pool.NodePool class method)</a> <li><a href="pomice.html#pomice.pool.NodePool.get_node">get_node() (pomice.pool.NodePool class method)</a>
</li> </li>
<li><a href="pomice.html#pomice.pool.Node.get_player">get_player() (pomice.pool.Node method)</a> <li><a href="pomice.html#pomice.pool.Node.get_player">get_player() (pomice.pool.Node method)</a>
@ -283,10 +322,12 @@
<li><a href="pomice.html#pomice.pool.Node">Node (class in pomice.pool)</a> <li><a href="pomice.html#pomice.pool.Node">Node (class in pomice.pool)</a>
</li> </li>
<li><a href="pomice.html#pomice.player.Player.node">node (pomice.player.Player property)</a> <li><a href="pomice.html#pomice.player.Player.node">node (pomice.player.Player property)</a>
</li>
<li><a href="pomice.html#pomice.pool.NodePool.node_count">node_count (pomice.pool.NodePool property)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pomice.html#pomice.pool.NodePool.node_count">node_count (pomice.pool.NodePool property)</a> <li><a href="pomice.html#pomice.enums.NodeAlgorithm">NodeAlgorithm (class in pomice.enums)</a>
</li> </li>
<li><a href="pomice.html#pomice.exceptions.NodeConnectionClosed">NodeConnectionClosed</a> <li><a href="pomice.html#pomice.exceptions.NodeConnectionClosed">NodeConnectionClosed</a>
</li> </li>
@ -445,6 +486,12 @@
<h2 id="R">R</h2> <h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pomice.html#pomice.pool.Node.region">region (pomice.pool.Node property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pomice.html#pomice.player.Player.reset_filter">reset_filter() (pomice.player.Player method)</a>
</li>
<li><a href="pomice.html#pomice.filters.Rotation">Rotation (class in pomice.filters)</a> <li><a href="pomice.html#pomice.filters.Rotation">Rotation (class in pomice.filters)</a>
</li> </li>
</ul></td> </ul></td>
@ -566,66 +613,31 @@
</div>
</div> </div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, cloudwithax.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div> </div>
</div> </div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> </section>
<div class="sphinxsidebarwrapper"> </div>
<h1 class="logo"><a href="index.html">Pomice</a></h1> <script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, cloudwithax.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html> </html>

171
docs/_build/html/index.html vendored
View File

@ -1,43 +1,75 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<html> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<head> <title>Welcome to Pomice! &mdash; Pomice 1.1.1 documentation</title>
<meta charset="utf-8" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<title>Welcome to Pomice! &#8212; Pomice 1.1.1 documentation</title> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <script src="_static/jquery.js"></script>
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="&lt;no title&gt;" href="modules.html" /> <link rel="next" title="&lt;no title&gt;" href="modules.html" />
</head>
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> Pomice
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
</div>
</div>
</nav>
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Pomice</a>
</nav>
</head><body> <div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div class="document"> <ul class="wy-breadcrumbs">
<div class="documentwrapper"> <li><a href="#" class="icon icon-home"></a> &raquo;</li>
<div class="bodywrapper"> <li>Welcome to Pomice!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
<div class="body" role="main"> </li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-pomice"> <section id="welcome-to-pomice">
<h1>Welcome to Pomice!<a class="headerlink" href="#welcome-to-pomice" title="Permalink to this headline"></a></h1> <h1>Welcome to Pomice!<a class="headerlink" href="#welcome-to-pomice" title="Permalink to this headline"></a></h1>
<img alt="https://raw.githubusercontent.com/cloudwithax/pomice/main/banner.jpg" src="https://raw.githubusercontent.com/cloudwithax/pomice/main/banner.jpg" /> <img alt="https://raw.githubusercontent.com/cloudwithax/pomice/main/banner.jpg" src="https://raw.githubusercontent.com/cloudwithax/pomice/main/banner.jpg" />
<p>The modern <a class="reference external" href="https://github.com/freyacodes/Lavalink">Lavalink</a> wrapper designed for <a class="reference external" href="https://github.com/Rapptz/discord.py">discord.py</a></p> <p>The modern <a class="reference external" href="https://github.com/freyacodes/Lavalink">Lavalink</a> wrapper designed for <a class="reference external" href="https://github.com/Rapptz/discord.py">discord.py</a></p>
<section id="contents"> <section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a><ul> <li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a><ul>
@ -63,7 +95,7 @@
</div> </div>
</section> </section>
<section id="before-you-start"> <section id="before-you-start">
<h2>Before You Start<a class="headerlink" href="#before-you-start" title="Permalink to this headline"></a></h2> <h2>Before You Start<a class="headerlink" href="#before-you-start" title="Permalink to this headline"></a></h2>
<p>This library is designed to work with the Lavalink audio delivery system, <p>This library is designed to work with the Lavalink audio delivery system,
which directly interfaces with Discord to provide buttery smooth audio without which directly interfaces with Discord to provide buttery smooth audio without
wasting your precious system resources.</p> wasting your precious system resources.</p>
@ -73,7 +105,7 @@ and is out of your way, while also being customizable.</p>
you can get it <a class="reference external" href="https://github.com/freyacodes/Lavalink/releases/latest">here</a></p> you can get it <a class="reference external" href="https://github.com/freyacodes/Lavalink/releases/latest">here</a></p>
</section> </section>
<section id="quick-jumpstart"> <section id="quick-jumpstart">
<h2>Quick Jumpstart<a class="headerlink" href="#quick-jumpstart" title="Permalink to this headline"></a></h2> <h2>Quick Jumpstart<a class="headerlink" href="#quick-jumpstart" title="Permalink to this headline"></a></h2>
<p>If you want a quick example as to how to start with Pomice, look below:</p> <p>If you want a quick example as to how to start with Pomice, look below:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pomice</span> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pomice</span>
<span class="kn">import</span> <span class="nn">discord</span> <span class="kn">import</span> <span class="nn">discord</span>
@ -149,70 +181,33 @@ you can get it <a class="reference external" href="https://github.com/freyacodes
</section> </section>
</div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="modules.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, cloudwithax.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div> </div>
</div> </div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> </section>
<div class="sphinxsidebarwrapper"> </div>
<h1 class="logo"><a href="#">Pomice</a></h1> <script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="modules.html" title="next chapter">&lt;no title&gt;</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, cloudwithax.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html> </html>

167
docs/_build/html/modules.html vendored
View File

@ -1,42 +1,74 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<html> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<head> <title>&lt;no title&gt; &mdash; Pomice 1.1.1 documentation</title>
<meta charset="utf-8" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<title>&lt;no title&gt; &#8212; Pomice 1.1.1 documentation</title> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <script src="_static/jquery.js"></script>
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Pomice" href="pomice.html" /> <link rel="next" title="Pomice" href="pomice.html" />
<link rel="prev" title="Welcome to Pomice!" href="index.html" /> <link rel="prev" title="Welcome to Pomice!" href="index.html" />
</head>
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Pomice
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
</div>
</div>
</nav>
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Pomice</a>
</nav>
</head><body> <div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div class="document"> <ul class="wy-breadcrumbs">
<div class="documentwrapper"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<div class="bodywrapper"> <li>&lt;no title&gt;</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/modules.rst.txt" rel="nofollow"> View page source</a>
<div class="body" role="main"> </li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a><ul> <li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pomice.spotify.html">pomice.spotify</a><ul> <li class="toctree-l2"><a class="reference internal" href="pomice.spotify.html">Spotify</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.album">spotify.Album</a></li> <li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.album">spotify.Album</a></li>
<li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.client">spotify.Client</a></li> <li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.client">spotify.Client</a></li>
<li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.exceptions">spotify.Exceptions</a></li> <li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.exceptions">spotify.Exceptions</a></li>
@ -58,71 +90,34 @@
</div> </div>
</div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to Pomice!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pomice.html" class="btn btn-neutral float-right" title="Pomice" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, cloudwithax.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div> </div>
</div> </div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> </section>
<div class="sphinxsidebarwrapper"> </div>
<h1 class="logo"><a href="index.html">Pomice</a></h1> <script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to Pomice!</a></li>
<li>Next: <a href="pomice.html" title="next chapter">Pomice</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, cloudwithax.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/modules.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html> </html>

BIN
docs/_build/html/objects.inv vendored
View File

Binary file not shown.

483
docs/_build/html/pomice.html vendored
View File

File diff suppressed because it is too large Load Diff

301
docs/_build/html/pomice.spotify.html vendored
View File

@ -1,123 +1,42 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<html> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<head> <title>Spotify &mdash; Pomice 1.1.1 documentation</title>
<meta charset="utf-8" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<title>Spotify &#8212; Pomice 1.1.1 documentation</title> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <script src="_static/jquery.js"></script>
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Pomice" href="pomice.html" /> <link rel="prev" title="Pomice" href="pomice.html" />
</head>
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> <div class="wy-side-scroll">
<div class="wy-side-nav-search" >
</head><body> <a href="index.html" class="icon icon-home"> Pomice
</a>
<div role="search">
<div class="document"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div class="documentwrapper"> <input type="text" name="q" placeholder="Search docs" />
<div class="bodywrapper"> <input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<div class="body" role="main"> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<section id="spotify"> <ul class="current">
<h1>Spotify<a class="headerlink" href="#spotify" title="Permalink to this headline"></a></h1>
<section id="module-pomice.spotify.album">
<span id="spotify-album"></span><h2>spotify.Album<a class="headerlink" href="#module-pomice.spotify.album" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pomice.spotify.album.Album">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.album.</span></span><span class="sig-name descname"><span class="pre">Album</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.album.Album" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The base class for a Spotify album</p>
</dd></dl>
</section>
<section id="module-pomice.spotify.client">
<span id="spotify-client"></span><h2>spotify.Client<a class="headerlink" href="#module-pomice.spotify.client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pomice.spotify.client.Client">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.client.</span></span><span class="sig-name descname"><span class="pre">Client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.client.Client" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The base client for the Spotify module of Pomice.
This class will do all the heavy lifting of getting all the metadata
for any Spotify URL you throw at it.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pomice.spotify.client.Client.search">
<em class="property"><span class="pre">async</span> </em><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.client.Client.search" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-pomice.spotify.exceptions">
<span id="spotify-exceptions"></span><h2>spotify.Exceptions<a class="headerlink" href="#module-pomice.spotify.exceptions" title="Permalink to this headline"></a></h2>
<dl class="py exception">
<dt class="sig sig-object py" id="pomice.spotify.exceptions.InvalidSpotifyURL">
<em class="property"><span class="pre">exception</span> </em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.exceptions.</span></span><span class="sig-name descname"><span class="pre">InvalidSpotifyURL</span></span><a class="headerlink" href="#pomice.spotify.exceptions.InvalidSpotifyURL" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>An invalid Spotify URL was passed</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="pomice.spotify.exceptions.SpotifyRequestException">
<em class="property"><span class="pre">exception</span> </em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.exceptions.</span></span><span class="sig-name descname"><span class="pre">SpotifyRequestException</span></span><a class="headerlink" href="#pomice.spotify.exceptions.SpotifyRequestException" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>An error occurred when making a request to the Spotify API</p>
</dd></dl>
</section>
<section id="module-pomice.spotify.playlist">
<span id="spotify-playlist"></span><h2>spotify.Playlist<a class="headerlink" href="#module-pomice.spotify.playlist" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pomice.spotify.playlist.Playlist">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.playlist.</span></span><span class="sig-name descname"><span class="pre">Playlist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tracks</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pomice.spotify.track.Track" title="pomice.spotify.track.Track"><span class="pre">pomice.spotify.track.Track</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.playlist.Playlist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The base class for a Spotify playlist</p>
</dd></dl>
</section>
<section id="module-pomice.spotify.track">
<span id="spotify-track"></span><h2>spotify.Track<a class="headerlink" href="#module-pomice.spotify.track" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pomice.spotify.track.Track">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.track.</span></span><span class="sig-name descname"><span class="pre">Track</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.track.Track" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The base class for a Spotify Track</p>
</dd></dl>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">Pomice</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="pomice.html">Pomice</a><ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="pomice.html">Pomice</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Spotify</a><ul> <li class="toctree-l2 current"><a class="current reference internal" href="#">Spotify</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-pomice.spotify.album">spotify.Album</a></li> <li class="toctree-l3"><a class="reference internal" href="#module-pomice.spotify.album">spotify.Album</a></li>
@ -139,54 +58,128 @@ for any Spotify URL you throw at it.</p>
</li> </li>
</ul> </ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">&lt;no title&gt;</a><ul>
<li><a href="pomice.html">Pomice</a><ul>
<li>Previous: <a href="pomice.html" title="previous chapter">Pomice</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div> </div>
</div> </div>
<div class="clearer"></div> </nav>
</div>
<div class="footer">
&copy;2021, cloudwithax.
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> <a href="index.html">Pomice</a>
</nav>
| <div class="wy-nav-content">
<a href="_sources/pomice.spotify.rst.txt" <div class="rst-content">
rel="nofollow">Page source</a> <div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="modules.html">&lt;no title&gt;</a> &raquo;</li>
<li><a href="pomice.html">Pomice</a> &raquo;</li>
<li>Spotify</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/pomice.spotify.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="spotify">
<h1>Spotify<a class="headerlink" href="#spotify" title="Permalink to this headline"></a></h1>
<section id="module-pomice.spotify.album">
<span id="spotify-album"></span><h2>spotify.Album<a class="headerlink" href="#module-pomice.spotify.album" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pomice.spotify.album.Album">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.album.</span></span><span class="sig-name descname"><span class="pre">Album</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.album.Album" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The base class for a Spotify album</p>
</dd></dl>
</section>
<section id="module-pomice.spotify.client">
<span id="spotify-client"></span><h2>spotify.Client<a class="headerlink" href="#module-pomice.spotify.client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pomice.spotify.client.Client">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.client.</span></span><span class="sig-name descname"><span class="pre">Client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.client.Client" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The base client for the Spotify module of Pomice.
This class will do all the heavy lifting of getting all the metadata
for any Spotify URL you throw at it.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pomice.spotify.client.Client.search">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.client.Client.search" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-pomice.spotify.exceptions">
<span id="spotify-exceptions"></span><h2>spotify.Exceptions<a class="headerlink" href="#module-pomice.spotify.exceptions" title="Permalink to this headline"></a></h2>
<dl class="py exception">
<dt class="sig sig-object py" id="pomice.spotify.exceptions.InvalidSpotifyURL">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.exceptions.</span></span><span class="sig-name descname"><span class="pre">InvalidSpotifyURL</span></span><a class="headerlink" href="#pomice.spotify.exceptions.InvalidSpotifyURL" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>An invalid Spotify URL was passed</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="pomice.spotify.exceptions.SpotifyRequestException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.exceptions.</span></span><span class="sig-name descname"><span class="pre">SpotifyRequestException</span></span><a class="headerlink" href="#pomice.spotify.exceptions.SpotifyRequestException" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>An error occurred when making a request to the Spotify API</p>
</dd></dl>
</section>
<section id="module-pomice.spotify.playlist">
<span id="spotify-playlist"></span><h2>spotify.Playlist<a class="headerlink" href="#module-pomice.spotify.playlist" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pomice.spotify.playlist.Playlist">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.playlist.</span></span><span class="sig-name descname"><span class="pre">Playlist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tracks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pomice.spotify.track.Track" title="pomice.spotify.track.Track"><span class="pre">pomice.spotify.track.Track</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.playlist.Playlist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The base class for a Spotify playlist</p>
</dd></dl>
</section>
<section id="module-pomice.spotify.track">
<span id="spotify-track"></span><h2>spotify.Track<a class="headerlink" href="#module-pomice.spotify.track" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pomice.spotify.track.Track">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pomice.spotify.track.</span></span><span class="sig-name descname"><span class="pre">Track</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pomice.spotify.track.Track" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The base class for a Spotify Track</p>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="pomice.html" class="btn btn-neutral float-left" title="Pomice" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, cloudwithax.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body> </body>
</html> </html>

156
docs/_build/html/py-modindex.html vendored
View File

@ -1,37 +1,68 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &mdash; Pomice 1.1.1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<html> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<head> <script src="_static/jquery.js"></script>
<meta charset="utf-8" /> <script src="_static/underscore.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <script src="_static/doctools.js"></script>
<title>Python Module Index &#8212; Pomice 1.1.1 documentation</title> <script src="_static/js/theme.js"></script>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head>
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Pomice
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Pomice</a>
</nav>
</head><body> <div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<div class="document"> <ul class="wy-breadcrumbs">
<div class="documentwrapper"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<div class="bodywrapper"> <li>Python Module Index</li>
<li class="wy-breadcrumbs-aside">
</li>
<div class="body" role="main"> </ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Python Module Index</h1> <h1>Python Module Index</h1>
@ -118,66 +149,31 @@
</table> </table>
</div>
</div> </div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, cloudwithax.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div> </div>
</div> </div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> </section>
<div class="sphinxsidebarwrapper"> </div>
<h1 class="logo"><a href="index.html">Pomice</a></h1> <script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, cloudwithax.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html> </html>

178
docs/_build/html/search.html vendored
View File

@ -1,122 +1,114 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; Pomice 1.1.1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<html> <!--[if lt IE 9]>
<head> <script src="_static/js/html5shiv.min.js"></script>
<meta charset="utf-8" /> <![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; Pomice 1.1.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<script src="_static/searchtools.js"></script> <script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script> <script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" /> <link rel="search" title="Search" href="#" />
<script src="searchindex.js" defer></script> </head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Pomice
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> </div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Pomice</a>
</nav>
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> <div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
</head><body> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Search</li>
<div class="document"> <li class="wy-breadcrumbs-aside">
<div class="documentwrapper"> </li>
<div class="bodywrapper"> </ul>
<hr/>
</div>
<div class="body" role="main"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1 id="search-documentation">Search</h1>
<noscript> <noscript>
<div class="admonition warning"> <div id="fallback" class="admonition warning">
<p> <p class="last">
Please activate JavaScript to enable the search Please activate JavaScript to enable the search functionality.
functionality. </p>
</p>
</div> </div>
</noscript> </noscript>
<p>
Searching for multiple words only shows matches that contain
all words.
</p>
<form action="" method="get">
<input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results"> <div id="search-results">
</div> </div>
</div>
</div> </div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, cloudwithax.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div> </div>
</div> </div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> </section>
<div class="sphinxsidebarwrapper"> </div>
<h1 class="logo"><a href="index.html">Pomice</a></h1> <script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script id="searchindexloader"></script>
</body>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, cloudwithax.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html> </html>

2
docs/_build/html/searchindex.js vendored
View File

File diff suppressed because one or more lines are too long

4
docs/conf.py
View File

@ -12,7 +12,7 @@
# #
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('..'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
@ -49,7 +49,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'alabaster' html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,

2
docs/requirements_rtd.txt
View File

@ -1 +1,3 @@
sphinx
sphinx-rtd-theme
git+https://github.com/Rapptz/discord.py git+https://github.com/Rapptz/discord.py