diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 7347ad9b0..0c35bfae7 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,3 +1,6 @@ -sphinx==3.5.2 -sphinx_rtd_theme==0.5.1 +sphinx==3.5.4 sphinx-pypi-upload +# When bumping this, make sure to rebuild the dark-mode CSS +# More instructions at source/_static/dark.css +# Ofc once https://github.com/readthedocs/sphinx_rtd_theme/issues/224 is closed, we should use that +sphinx_rtd_theme==0.5.2 diff --git a/docs/source/_static/dark.css b/docs/source/_static/dark.css new file mode 100644 index 000000000..f8ec9fd08 --- /dev/null +++ b/docs/source/_static/dark.css @@ -0,0 +1,3461 @@ +@media (prefers-color-scheme: dark) { + /* + Generated by https://darkreader.org + Instructions: Install the extension on a Chromium-based browser + Then do this to export the CSS: https://git.io/JOM6t and drop it here + Some color values where manually changed - just search for "/*" in this file and insert them in the new css + */ + /* User-Agent Style */ + html { + background-color: #181a1b !important; + } + html, body, input, textarea, select, button { + background-color: #181a1b; + } + html, body, input, textarea, select, button { + border-color: #736b5e; + color: #e8e6e3; + } + a { + color: #3391ff; + } + table { + border-color: #545b5e; + } + ::placeholder { + color: #b2aba1; + } + input:-webkit-autofill, + textarea:-webkit-autofill, + select:-webkit-autofill { + background-color: #555b00 !important; + color: #e8e6e3 !important; + } + ::-webkit-scrollbar { + background-color: #202324; + color: #aba499; + } + ::-webkit-scrollbar-thumb { + background-color: #454a4d; + } + ::-webkit-scrollbar-thumb:hover { + background-color: #575e62; + } + ::-webkit-scrollbar-thumb:active { + background-color: #484e51; + } + ::-webkit-scrollbar-corner { + background-color: #181a1b; + } + ::selection { + background-color: #004daa !important; + color: #e8e6e3 !important; + } + ::-moz-selection { + background-color: #004daa !important; + color: #e8e6e3 !important; + } + + /* Invert Style */ + .jfk-bubble.gtx-bubble, .captcheck_answer_label > input + img, span#closed_text > img[src^="https://www.gstatic.com/images/branding/googlelogo"], span[data-href^="https://www.hcaptcha.com/"] > #icon, #bit-notification-bar-iframe, embed[type="application/pdf"] { + filter: invert(100%) hue-rotate(180deg) contrast(90%) !important; + } + + /* Variables Style */ + :root { + --darkreader-neutral-background: #131516; + --darkreader-neutral-text: #d8d4cf; + --darkreader-selection-background: #004daa; + --darkreader-selection-text: #e8e6e3; + } + + /* Modified CSS */ + a:active, + a:hover { + outline-color: initial; + } + abbr[title] { + border-bottom-color: initial; + } + ins { + background-image: initial; + background-color: rgb(112, 112, 0); + text-decoration-color: initial; + } + ins, + mark { + color: rgb(232, 230, 227); + } + mark { + background-image: initial; + background-color: rgb(204, 204, 0); + } + dl, + ol, + ul { + list-style-image: none; + } + li { + list-style-image: initial; + } + img { + border-color: initial; + } + .chromeframe { + background-image: initial; + background-color: rgb(53, 57, 59); + color: rgb(232, 230, 227); + } + .ir { + border-color: initial; + background-color: transparent; + } + .visuallyhidden { + border-color: initial; + } + .fa-border { + border-color: rgb(53, 57, 59); + } + .fa-inverse { + color: rgb(232, 230, 227); + } + .sr-only { + border-color: initial; + } + .fa::before, + .icon::before, + .rst-content .admonition-title::before, + .rst-content .code-block-caption .headerlink::before, + .rst-content code.download span:first-child::before, + .rst-content dl dt .headerlink::before, + .rst-content h1 .headerlink::before, + .rst-content h2 .headerlink::before, + .rst-content h3 .headerlink::before, + .rst-content h4 .headerlink::before, + .rst-content h5 .headerlink::before, + .rst-content h6 .headerlink::before, + .rst-content p.caption .headerlink::before, + .rst-content table > caption .headerlink::before, + .rst-content tt.download span:first-child::before, + .wy-dropdown .caret::before, + .wy-inline-validate.wy-inline-validate-danger .wy-input-context::before, + .wy-inline-validate.wy-inline-validate-info .wy-input-context::before, + .wy-inline-validate.wy-inline-validate-success .wy-input-context::before, + .wy-inline-validate.wy-inline-validate-warning .wy-input-context::before, + .wy-menu-vertical li.current > a span.toctree-expand::before, + .wy-menu-vertical li.on a span.toctree-expand::before, + .wy-menu-vertical li span.toctree-expand::before { + text-decoration-color: inherit; + } + .rst-content .code-block-caption a .headerlink, + .rst-content a .admonition-title, + .rst-content code.download a span:first-child, + .rst-content dl dt a .headerlink, + .rst-content h1 a .headerlink, + .rst-content h2 a .headerlink, + .rst-content h3 a .headerlink, + .rst-content h4 a .headerlink, + .rst-content h5 a .headerlink, + .rst-content h6 a .headerlink, + .rst-content p.caption a .headerlink, + .rst-content table > caption a .headerlink, + .rst-content tt.download a span:first-child, + .wy-menu-vertical li.current > a span.toctree-expand, + .wy-menu-vertical li.on a span.toctree-expand, + .wy-menu-vertical li a span.toctree-expand, + a .fa, + a .icon, + a .rst-content .admonition-title, + a .rst-content .code-block-caption .headerlink, + a .rst-content code.download span:first-child, + a .rst-content dl dt .headerlink, + a .rst-content h1 .headerlink, + a .rst-content h2 .headerlink, + a .rst-content h3 .headerlink, + a .rst-content h4 .headerlink, + a .rst-content h5 .headerlink, + a .rst-content h6 .headerlink, + a .rst-content p.caption .headerlink, + a .rst-content table > caption .headerlink, + a .rst-content tt.download span:first-child, + a .wy-menu-vertical li span.toctree-expand { + text-decoration-color: inherit; + } + .rst-content .admonition, + .rst-content .admonition-todo, + .rst-content .attention, + .rst-content .caution, + .rst-content .danger, + .rst-content .error, + .rst-content .hint, + .rst-content .important, + .rst-content .note, + .rst-content .seealso, + .rst-content .tip, + .rst-content .warning, + .wy-alert { + background-image: initial; + background-color: rgb(32, 35, 36); + } + .rst-content .admonition-title, + .wy-alert-title { + color: rgb(232, 230, 227); + background-image: initial; + background-color: rgb(29, 91, 131); + } + .rst-content .danger, + .rst-content .error, + .rst-content .wy-alert-danger.admonition, + .rst-content .wy-alert-danger.admonition-todo, + .rst-content .wy-alert-danger.attention, + .rst-content .wy-alert-danger.caution, + .rst-content .wy-alert-danger.hint, + .rst-content .wy-alert-danger.important, + .rst-content .wy-alert-danger.note, + .rst-content .wy-alert-danger.seealso, + .rst-content .wy-alert-danger.tip, + .rst-content .wy-alert-danger.warning, + .wy-alert.wy-alert-danger { + background-image: initial; + background-color: rgb(52, 12, 8); + } + .rst-content .danger .admonition-title, + .rst-content .danger .wy-alert-title, + .rst-content .error .admonition-title, + .rst-content .error .wy-alert-title, + .rst-content .wy-alert-danger.admonition-todo .admonition-title, + .rst-content .wy-alert-danger.admonition-todo .wy-alert-title, + .rst-content .wy-alert-danger.admonition .admonition-title, + .rst-content .wy-alert-danger.admonition .wy-alert-title, + .rst-content .wy-alert-danger.attention .admonition-title, + .rst-content .wy-alert-danger.attention .wy-alert-title, + .rst-content .wy-alert-danger.caution .admonition-title, + .rst-content .wy-alert-danger.caution .wy-alert-title, + .rst-content .wy-alert-danger.hint .admonition-title, + .rst-content .wy-alert-danger.hint .wy-alert-title, + .rst-content .wy-alert-danger.important .admonition-title, + .rst-content .wy-alert-danger.important .wy-alert-title, + .rst-content .wy-alert-danger.note .admonition-title, + .rst-content .wy-alert-danger.note .wy-alert-title, + .rst-content .wy-alert-danger.seealso .admonition-title, + .rst-content .wy-alert-danger.seealso .wy-alert-title, + .rst-content .wy-alert-danger.tip .admonition-title, + .rst-content .wy-alert-danger.tip .wy-alert-title, + .rst-content .wy-alert-danger.warning .admonition-title, + .rst-content .wy-alert-danger.warning .wy-alert-title, + .rst-content .wy-alert.wy-alert-danger .admonition-title, + .wy-alert.wy-alert-danger .rst-content .admonition-title, + .wy-alert.wy-alert-danger .wy-alert-title { + background-image: initial; + background-color: rgb(108, 22, 13); + } + .rst-content .admonition-todo, + .rst-content .attention, + .rst-content .caution, + .rst-content .warning, + .rst-content .wy-alert-warning.admonition, + .rst-content .wy-alert-warning.danger, + .rst-content .wy-alert-warning.error, + .rst-content .wy-alert-warning.hint, + .rst-content .wy-alert-warning.important, + .rst-content .wy-alert-warning.note, + .rst-content .wy-alert-warning.seealso, + .rst-content .wy-alert-warning.tip, + .wy-alert.wy-alert-warning { + background-image: initial; + /* Manually overridden */ + background-color: rgb(37, 33, 30); + /*background-color: rgb(82, 53, 0);*/ + } + .rst-content .admonition-todo .admonition-title, + .rst-content .admonition-todo .wy-alert-title, + .rst-content .attention .admonition-title, + .rst-content .attention .wy-alert-title, + .rst-content .caution .admonition-title, + .rst-content .caution .wy-alert-title, + .rst-content .warning .admonition-title, + .rst-content .warning .wy-alert-title, + .rst-content .wy-alert-warning.admonition .admonition-title, + .rst-content .wy-alert-warning.admonition .wy-alert-title, + .rst-content .wy-alert-warning.danger .admonition-title, + .rst-content .wy-alert-warning.danger .wy-alert-title, + .rst-content .wy-alert-warning.error .admonition-title, + .rst-content .wy-alert-warning.error .wy-alert-title, + .rst-content .wy-alert-warning.hint .admonition-title, + .rst-content .wy-alert-warning.hint .wy-alert-title, + .rst-content .wy-alert-warning.important .admonition-title, + .rst-content .wy-alert-warning.important .wy-alert-title, + .rst-content .wy-alert-warning.note .admonition-title, + .rst-content .wy-alert-warning.note .wy-alert-title, + .rst-content .wy-alert-warning.seealso .admonition-title, + .rst-content .wy-alert-warning.seealso .wy-alert-title, + .rst-content .wy-alert-warning.tip .admonition-title, + .rst-content .wy-alert-warning.tip .wy-alert-title, + .rst-content .wy-alert.wy-alert-warning .admonition-title, + .wy-alert.wy-alert-warning .rst-content .admonition-title, + .wy-alert.wy-alert-warning .wy-alert-title { + background-image: initial; + background-color: rgb(123, 65, 14); + } + .rst-content .note, + .rst-content .seealso, + .rst-content .wy-alert-info.admonition, + .rst-content .wy-alert-info.admonition-todo, + .rst-content .wy-alert-info.attention, + .rst-content .wy-alert-info.caution, + .rst-content .wy-alert-info.danger, + .rst-content .wy-alert-info.error, + .rst-content .wy-alert-info.hint, + .rst-content .wy-alert-info.important, + .rst-content .wy-alert-info.tip, + .rst-content .wy-alert-info.warning, + .wy-alert.wy-alert-info { + background-image: initial; + background-color: rgb(32, 35, 36); + } + .rst-content .note .admonition-title, + .rst-content .note .wy-alert-title, + .rst-content .seealso .admonition-title, + .rst-content .seealso .wy-alert-title, + .rst-content .wy-alert-info.admonition-todo .admonition-title, + .rst-content .wy-alert-info.admonition-todo .wy-alert-title, + .rst-content .wy-alert-info.admonition .admonition-title, + .rst-content .wy-alert-info.admonition .wy-alert-title, + .rst-content .wy-alert-info.attention .admonition-title, + .rst-content .wy-alert-info.attention .wy-alert-title, + .rst-content .wy-alert-info.caution .admonition-title, + .rst-content .wy-alert-info.caution .wy-alert-title, + .rst-content .wy-alert-info.danger .admonition-title, + .rst-content .wy-alert-info.danger .wy-alert-title, + .rst-content .wy-alert-info.error .admonition-title, + .rst-content .wy-alert-info.error .wy-alert-title, + .rst-content .wy-alert-info.hint .admonition-title, + .rst-content .wy-alert-info.hint .wy-alert-title, + .rst-content .wy-alert-info.important .admonition-title, + .rst-content .wy-alert-info.important .wy-alert-title, + .rst-content .wy-alert-info.tip .admonition-title, + .rst-content .wy-alert-info.tip .wy-alert-title, + .rst-content .wy-alert-info.warning .admonition-title, + .rst-content .wy-alert-info.warning .wy-alert-title, + .rst-content .wy-alert.wy-alert-info .admonition-title, + .wy-alert.wy-alert-info .rst-content .admonition-title, + .wy-alert.wy-alert-info .wy-alert-title { + background-image: initial; + background-color: rgb(29, 91, 131); + } + .rst-content .hint, + .rst-content .important, + .rst-content .tip, + .rst-content .wy-alert-success.admonition, + .rst-content .wy-alert-success.admonition-todo, + .rst-content .wy-alert-success.attention, + .rst-content .wy-alert-success.caution, + .rst-content .wy-alert-success.danger, + .rst-content .wy-alert-success.error, + .rst-content .wy-alert-success.note, + .rst-content .wy-alert-success.seealso, + .rst-content .wy-alert-success.warning, + .wy-alert.wy-alert-success { + background-image: initial; + background-color: rgb(9, 66, 58); + } + .rst-content .hint .admonition-title, + .rst-content .hint .wy-alert-title, + .rst-content .important .admonition-title, + .rst-content .important .wy-alert-title, + .rst-content .tip .admonition-title, + .rst-content .tip .wy-alert-title, + .rst-content .wy-alert-success.admonition-todo .admonition-title, + .rst-content .wy-alert-success.admonition-todo .wy-alert-title, + .rst-content .wy-alert-success.admonition .admonition-title, + .rst-content .wy-alert-success.admonition .wy-alert-title, + .rst-content .wy-alert-success.attention .admonition-title, + .rst-content .wy-alert-success.attention .wy-alert-title, + .rst-content .wy-alert-success.caution .admonition-title, + .rst-content .wy-alert-success.caution .wy-alert-title, + .rst-content .wy-alert-success.danger .admonition-title, + .rst-content .wy-alert-success.danger .wy-alert-title, + .rst-content .wy-alert-success.error .admonition-title, + .rst-content .wy-alert-success.error .wy-alert-title, + .rst-content .wy-alert-success.note .admonition-title, + .rst-content .wy-alert-success.note .wy-alert-title, + .rst-content .wy-alert-success.seealso .admonition-title, + .rst-content .wy-alert-success.seealso .wy-alert-title, + .rst-content .wy-alert-success.warning .admonition-title, + .rst-content .wy-alert-success.warning .wy-alert-title, + .rst-content .wy-alert.wy-alert-success .admonition-title, + .wy-alert.wy-alert-success .rst-content .admonition-title, + .wy-alert.wy-alert-success .wy-alert-title { + background-image: initial; + background-color: rgb(21, 150, 125); + } + .rst-content .wy-alert-neutral.admonition, + .rst-content .wy-alert-neutral.admonition-todo, + .rst-content .wy-alert-neutral.attention, + .rst-content .wy-alert-neutral.caution, + .rst-content .wy-alert-neutral.danger, + .rst-content .wy-alert-neutral.error, + .rst-content .wy-alert-neutral.hint, + .rst-content .wy-alert-neutral.important, + .rst-content .wy-alert-neutral.note, + .rst-content .wy-alert-neutral.seealso, + .rst-content .wy-alert-neutral.tip, + .rst-content .wy-alert-neutral.warning, + .wy-alert.wy-alert-neutral { + background-image: initial; + background-color: rgb(27, 36, 36); + } + .rst-content .wy-alert-neutral.admonition-todo .admonition-title, + .rst-content .wy-alert-neutral.admonition-todo .wy-alert-title, + .rst-content .wy-alert-neutral.admonition .admonition-title, + .rst-content .wy-alert-neutral.admonition .wy-alert-title, + .rst-content .wy-alert-neutral.attention .admonition-title, + .rst-content .wy-alert-neutral.attention .wy-alert-title, + .rst-content .wy-alert-neutral.caution .admonition-title, + .rst-content .wy-alert-neutral.caution .wy-alert-title, + .rst-content .wy-alert-neutral.danger .admonition-title, + .rst-content .wy-alert-neutral.danger .wy-alert-title, + .rst-content .wy-alert-neutral.error .admonition-title, + .rst-content .wy-alert-neutral.error .wy-alert-title, + .rst-content .wy-alert-neutral.hint .admonition-title, + .rst-content .wy-alert-neutral.hint .wy-alert-title, + .rst-content .wy-alert-neutral.important .admonition-title, + .rst-content .wy-alert-neutral.important .wy-alert-title, + .rst-content .wy-alert-neutral.note .admonition-title, + .rst-content .wy-alert-neutral.note .wy-alert-title, + .rst-content .wy-alert-neutral.seealso .admonition-title, + .rst-content .wy-alert-neutral.seealso .wy-alert-title, + .rst-content .wy-alert-neutral.tip .admonition-title, + .rst-content .wy-alert-neutral.tip .wy-alert-title, + .rst-content .wy-alert-neutral.warning .admonition-title, + .rst-content .wy-alert-neutral.warning .wy-alert-title, + .rst-content .wy-alert.wy-alert-neutral .admonition-title, + .wy-alert.wy-alert-neutral .rst-content .admonition-title, + .wy-alert.wy-alert-neutral .wy-alert-title { + color: rgb(192, 186, 178); + background-image: initial; + background-color: rgb(40, 43, 45); + } + .rst-content .wy-alert-neutral.admonition-todo a, + .rst-content .wy-alert-neutral.admonition a, + .rst-content .wy-alert-neutral.attention a, + .rst-content .wy-alert-neutral.caution a, + .rst-content .wy-alert-neutral.danger a, + .rst-content .wy-alert-neutral.error a, + .rst-content .wy-alert-neutral.hint a, + .rst-content .wy-alert-neutral.important a, + .rst-content .wy-alert-neutral.note a, + .rst-content .wy-alert-neutral.seealso a, + .rst-content .wy-alert-neutral.tip a, + .rst-content .wy-alert-neutral.warning a, + .wy-alert.wy-alert-neutral a { + color: rgb(84, 164, 217); + } + .wy-tray-container li { + background-image: initial; + background-color: transparent; + color: rgb(232, 230, 227); + box-shadow: rgba(0, 0, 0, 0.1) 0px 5px 5px 0px; + } + .wy-tray-container li.wy-tray-item-success { + background-image: initial; + background-color: rgb(31, 139, 77); + } + .wy-tray-container li.wy-tray-item-info { + background-image: initial; + background-color: rgb(33, 102, 148); + } + .wy-tray-container li.wy-tray-item-warning { + background-image: initial; + background-color: rgb(178, 94, 20); + } + .wy-tray-container li.wy-tray-item-danger { + background-image: initial; + background-color: rgb(162, 33, 20); + } + .btn { + color: rgb(232, 230, 227); + border-color: rgba(140, 130, 115, 0.1); + background-color: rgb(31, 139, 77); + text-decoration-color: initial; + box-shadow: rgba(24, 26, 27, 0.5) 0px 1px 2px -1px inset, + rgba(0, 0, 0, 0.1) 0px -2px 0px 0px inset; + } + .btn-hover { + background-image: initial; + background-color: rgb(37, 114, 165); + color: rgb(232, 230, 227); + } + .btn:hover { + background-image: initial; + background-color: rgb(35, 156, 86); + color: rgb(232, 230, 227); + } + .btn:focus { + background-image: initial; + background-color: rgb(35, 156, 86); + outline-color: initial; + } + .btn:active { + box-shadow: rgba(0, 0, 0, 0.05) 0px -1px 0px 0px inset, + rgba(0, 0, 0, 0.1) 0px 2px 0px 0px inset; + } + .btn:visited { + color: rgb(232, 230, 227); + } + .btn-disabled, + .btn-disabled:active, + .btn-disabled:focus, + .btn-disabled:hover, + .btn:disabled { + background-image: none; + box-shadow: none; + } + .btn-info { + background-color: rgb(33, 102, 148) !important; + } + .btn-info:hover { + background-color: rgb(37, 114, 165) !important; + } + .btn-neutral { + background-color: rgb(27, 36, 36) !important; + color: rgb(192, 186, 178) !important; + } + .btn-neutral:hover { + color: rgb(192, 186, 178); + background-color: rgb(34, 44, 44) !important; + } + .btn-neutral:visited { + color: rgb(192, 186, 178) !important; + } + .btn-success { + background-color: rgb(31, 139, 77) !important; + } + .btn-success:hover { + background-color: rgb(27, 122, 68) !important; + } + .btn-danger { + background-color: rgb(162, 33, 20) !important; + } + .btn-danger:hover { + background-color: rgb(149, 30, 18) !important; + } + .btn-warning { + background-color: rgb(178, 94, 20) !important; + } + .btn-warning:hover { + background-color: rgb(165, 87, 18) !important; + } + .btn-invert { + background-color: rgb(26, 28, 29); + } + .btn-invert:hover { + background-color: rgb(35, 38, 40) !important; + } + .btn-link { + color: rgb(84, 164, 217); + box-shadow: none; + background-color: transparent !important; + border-color: transparent !important; + } + .btn-link:active, + .btn-link:hover { + box-shadow: none; + background-color: transparent !important; + color: rgb(79, 162, 216) !important; + } + .btn-link:visited { + color: rgb(164, 103, 188); + } + .wy-dropdown-menu { + background-image: initial; + background-color: rgb(26, 28, 29); + border-color: rgb(60, 65, 67); + box-shadow: rgba(0, 0, 0, 0.1) 0px 2px 2px 0px; + } + .wy-dropdown-menu > dd > a { + color: rgb(192, 186, 178); + } + .wy-dropdown-menu > dd > a:hover { + background-image: initial; + background-color: rgb(33, 102, 148); + color: rgb(232, 230, 227); + } + .wy-dropdown-menu > dd.divider { + border-top-color: rgb(60, 65, 67); + } + .wy-dropdown-menu > dd.call-to-action { + background-image: initial; + background-color: rgb(40, 43, 45); + } + .wy-dropdown-menu > dd.call-to-action:hover { + background-image: initial; + background-color: rgb(40, 43, 45); + } + .wy-dropdown-menu > dd.call-to-action .btn { + color: rgb(232, 230, 227); + } + .wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu { + background-image: initial; + background-color: rgb(26, 28, 29); + } + .wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover { + background-image: initial; + background-color: rgb(33, 102, 148); + color: rgb(232, 230, 227); + } + .wy-dropdown-arrow::before { + border-bottom-color: rgb(51, 55, 57); + border-left-color: transparent; + border-right-color: transparent; + } + fieldset, + legend { + border-color: initial; + } + label { + color: rgb(200, 195, 188); + } + .wy-control-group.wy-control-group-required > label::after { + color: rgb(233, 88, 73); + } + .wy-form-message-inline { + color: rgb(168, 160, 149); + } + .wy-form-message { + color: rgb(168, 160, 149); + } + input[type="color"], input[type="date"], input[type="datetime-local"], input[type="datetime"], input[type="email"], input[type="month"], input[type="number"], input[type="password"], input[type="search"], input[type="tel"], input[type="text"], input[type="time"], input[type="url"], input[type="week"] { + border-color: rgb(62, 68, 70); + box-shadow: rgb(43, 47, 49) 0px 1px 3px inset; + } + input[type="color"]:focus, input[type="date"]:focus, input[type="datetime-local"]:focus, input[type="datetime"]:focus, input[type="email"]:focus, input[type="month"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="time"]:focus, input[type="url"]:focus, input[type="week"]:focus { + outline-color: initial; + border-color: rgb(123, 114, 101); + } + input.no-focus:focus { + border-color: rgb(62, 68, 70) !important; + } + input[type="checkbox"]:focus, input[type="file"]:focus, input[type="radio"]:focus { + outline-color: rgb(13, 113, 167); + } + input[type="color"][disabled], input[type="date"][disabled], input[type="datetime-local"][disabled], input[type="datetime"][disabled], input[type="email"][disabled], input[type="month"][disabled], input[type="number"][disabled], input[type="password"][disabled], input[type="search"][disabled], input[type="tel"][disabled], input[type="text"][disabled], input[type="time"][disabled], input[type="url"][disabled], input[type="week"][disabled] { + background-color: rgb(27, 29, 30); + } + input:focus:invalid, + select:focus:invalid, + textarea:focus:invalid { + color: rgb(233, 88, 73); + border-color: rgb(149, 31, 18); + } + input:focus:invalid:focus, + select:focus:invalid:focus, + textarea:focus:invalid:focus { + border-color: rgb(149, 31, 18); + } + input[type="checkbox"]:focus:invalid:focus, input[type="file"]:focus:invalid:focus, input[type="radio"]:focus:invalid:focus { + outline-color: rgb(149, 31, 18); + } + select, + textarea { + border-color: rgb(62, 68, 70); + box-shadow: rgb(43, 47, 49) 0px 1px 3px inset; + } + select { + border-color: rgb(62, 68, 70); + background-color: rgb(24, 26, 27); + } + select:focus, + textarea:focus { + outline-color: initial; + } + input[readonly], + select[disabled], + select[readonly], + textarea[disabled], + textarea[readonly] { + background-color: rgb(27, 29, 30); + } + .wy-checkbox, + .wy-radio { + color: rgb(192, 186, 178); + } + .wy-input-prefix .wy-input-context, + .wy-input-suffix .wy-input-context { + background-color: rgb(27, 36, 36); + border-color: rgb(62, 68, 70); + color: rgb(168, 160, 149); + } + .wy-input-suffix .wy-input-context { + border-left-color: initial; + } + .wy-input-prefix .wy-input-context { + border-right-color: initial; + } + .wy-switch::before { + background-image: initial; + background-color: rgb(53, 57, 59); + } + .wy-switch::after { + background-image: initial; + background-color: rgb(82, 88, 92); + } + .wy-switch span { + color: rgb(200, 195, 188); + } + .wy-switch.active::before { + background-image: initial; + background-color: rgb(24, 106, 58); + } + .wy-switch.active::after { + background-image: initial; + background-color: rgb(31, 139, 77); + } + .wy-control-group.wy-control-group-error .wy-form-message, + .wy-control-group.wy-control-group-error > label { + color: rgb(233, 88, 73); + } + .wy-control-group.wy-control-group-error input[type="color"], .wy-control-group.wy-control-group-error input[type="date"], .wy-control-group.wy-control-group-error input[type="datetime-local"], .wy-control-group.wy-control-group-error input[type="datetime"], .wy-control-group.wy-control-group-error input[type="email"], .wy-control-group.wy-control-group-error input[type="month"], .wy-control-group.wy-control-group-error input[type="number"], .wy-control-group.wy-control-group-error input[type="password"], .wy-control-group.wy-control-group-error input[type="search"], .wy-control-group.wy-control-group-error input[type="tel"], .wy-control-group.wy-control-group-error input[type="text"], .wy-control-group.wy-control-group-error input[type="time"], .wy-control-group.wy-control-group-error input[type="url"], .wy-control-group.wy-control-group-error input[type="week"], + .wy-control-group.wy-control-group-error textarea { + border-color: rgb(149, 31, 18); + } + .wy-inline-validate.wy-inline-validate-success .wy-input-context { + color: rgb(92, 218, 145); + } + .wy-inline-validate.wy-inline-validate-danger .wy-input-context { + color: rgb(233, 88, 73); + } + .wy-inline-validate.wy-inline-validate-warning .wy-input-context { + color: rgb(232, 138, 54); + } + .wy-inline-validate.wy-inline-validate-info .wy-input-context { + color: rgb(84, 164, 217); + } + .rst-content table.docutils caption, + .rst-content table.field-list caption, + .wy-table caption { + color: rgb(232, 230, 227); + } + .rst-content table.docutils thead, + .rst-content table.field-list thead, + .wy-table thead { + color: rgb(232, 230, 227); + } + .rst-content table.docutils thead th, + .rst-content table.field-list thead th, + .wy-table thead th { + border-bottom-color: rgb(56, 61, 63); + } + .rst-content table.docutils td, + .rst-content table.field-list td, + .wy-table td { + background-color: transparent; + } + .wy-table-secondary { + color: rgb(152, 143, 129); + } + .wy-table-tertiary { + color: rgb(152, 143, 129); + } + .rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td, + .wy-table-backed, + .wy-table-odd td, + .wy-table-striped tr:nth-child(2n-1) td { + background-color: rgb(27, 36, 36); + } + .rst-content table.docutils, + .wy-table-bordered-all { + border-color: rgb(56, 61, 63); + } + .rst-content table.docutils td, + .wy-table-bordered-all td { + border-bottom-color: rgb(56, 61, 63); + border-left-color: rgb(56, 61, 63); + } + .wy-table-bordered { + border-color: rgb(56, 61, 63); + } + .wy-table-bordered-rows td { + border-bottom-color: rgb(56, 61, 63); + } + .wy-table-horizontal td, + .wy-table-horizontal th { + border-bottom-color: rgb(56, 61, 63); + } + a { + color: rgb(84, 164, 217); + text-decoration-color: initial; + } + a:hover { + color: rgb(68, 156, 214); + } + a:visited { + color: rgb(164, 103, 188); + } + body { + color: rgb(192, 186, 178); + background-image: initial; + background-color: rgb(33, 35, 37); + } + .wy-text-strike { + text-decoration-color: initial; + } + .wy-text-warning { + color: rgb(232, 138, 54) !important; + } + a.wy-text-warning:hover { + color: rgb(236, 157, 87) !important; + } + .wy-text-info { + color: rgb(84, 164, 217) !important; + } + a.wy-text-info:hover { + color: rgb(79, 162, 216) !important; + } + .wy-text-success { + color: rgb(92, 218, 145) !important; + } + a.wy-text-success:hover { + color: rgb(73, 214, 133) !important; + } + .wy-text-danger { + color: rgb(233, 88, 73) !important; + } + a.wy-text-danger:hover { + color: rgb(237, 118, 104) !important; + } + .wy-text-neutral { + color: rgb(192, 186, 178) !important; + } + a.wy-text-neutral:hover { + color: rgb(176, 169, 159) !important; + } + hr { + border-right-color: initial; + border-bottom-color: initial; + border-left-color: initial; + border-top-color: rgb(56, 61, 63); + } + .rst-content code, + .rst-content tt, + code { + background-image: initial; + background-color: rgb(24, 26, 27); + border-color: rgb(56, 61, 63); + color: rgb(233, 88, 73); + } + .rst-content .section ul, + .rst-content .toctree-wrapper ul, + .wy-plain-list-disc, + article ul { + list-style-image: initial; + } + .rst-content .section ul li, + .rst-content .toctree-wrapper ul li, + .wy-plain-list-disc li, + article ul li { + list-style-image: initial; + } + .rst-content .section ul li li, + .rst-content .toctree-wrapper ul li li, + .wy-plain-list-disc li li, + article ul li li { + list-style-image: initial; + } + .rst-content .section ul li li li, + .rst-content .toctree-wrapper ul li li li, + .wy-plain-list-disc li li li, + article ul li li li { + list-style-image: initial; + } + .rst-content .section ul li ol li, + .rst-content .toctree-wrapper ul li ol li, + .wy-plain-list-disc li ol li, + article ul li ol li { + list-style-image: initial; + } + .rst-content .section ol, + .rst-content ol.arabic, + .wy-plain-list-decimal, + article ol { + list-style-image: initial; + } + .rst-content .section ol li, + .rst-content ol.arabic li, + .wy-plain-list-decimal li, + article ol li { + list-style-image: initial; + } + .rst-content .section ol li ul li, + .rst-content ol.arabic li ul li, + .wy-plain-list-decimal li ul li, + article ol li ul li { + list-style-image: initial; + } + .rst-content .wy-breadcrumbs li tt, + .wy-breadcrumbs li .rst-content tt, + .wy-breadcrumbs li code { + border-color: initial; + background-image: none; + background-color: initial; + } + .rst-content .wy-breadcrumbs li tt.literal, + .wy-breadcrumbs li .rst-content tt.literal, + .wy-breadcrumbs li code.literal { + color: rgb(192, 186, 178); + } + .wy-breadcrumbs-extra { + color: rgb(184, 178, 169); + } + .wy-menu a:hover { + text-decoration-color: initial; + } + .wy-menu-horiz li:hover { + background-image: initial; + background-color: rgba(24, 26, 27, 0.1); + } + .wy-menu-horiz li.divide-left { + border-left-color: rgb(119, 110, 98); + } + .wy-menu-horiz li.divide-right { + border-right-color: rgb(119, 110, 98); + } + .wy-menu-vertical header, + .wy-menu-vertical p.caption { + color: rgb(94, 170, 219); + } + .wy-menu-vertical li.divide-top { + border-top-color: rgb(119, 110, 98); + } + .wy-menu-vertical li.divide-bottom { + border-bottom-color: rgb(119, 110, 98); + } + .wy-menu-vertical li.current { + background-image: initial; + background-color: rgb(40, 43, 45); + } + .wy-menu-vertical li.current a { + color: rgb(152, 143, 129); + border-right-color: rgb(63, 69, 71); + } + .wy-menu-vertical li.current a:hover { + background-image: initial; + background-color: rgb(47, 51, 53); + } + .rst-content .wy-menu-vertical li tt, + .wy-menu-vertical li .rst-content tt, + .wy-menu-vertical li code { + border-color: initial; + background-image: inherit; + background-color: inherit; + color: inherit; + } + .wy-menu-vertical li span.toctree-expand { + color: rgb(183, 177, 168); + } + .wy-menu-vertical li.current > a, + .wy-menu-vertical li.on a { + color: rgb(192, 186, 178); + background-image: initial; + background-color: rgb(26, 28, 29); + border-color: initial; + } + .wy-menu-vertical li.current > a:hover, + .wy-menu-vertical li.on a:hover { + background-image: initial; + background-color: rgb(26, 28, 29); + } + .wy-menu-vertical li.current > a:hover span.toctree-expand, + .wy-menu-vertical li.on a:hover span.toctree-expand { + color: rgb(152, 143, 129); + } + .wy-menu-vertical li.current > a span.toctree-expand, + .wy-menu-vertical li.on a span.toctree-expand { + color: rgb(200, 195, 188); + } + .wy-menu-vertical li.toctree-l1.current > a { + border-bottom-color: rgb(63, 69, 71); + border-top-color: rgb(63, 69, 71); + } + .wy-menu-vertical li.toctree-l2 a, + .wy-menu-vertical li.toctree-l3 a, + .wy-menu-vertical li.toctree-l4 a, + .wy-menu-vertical li.toctree-l5 a, + .wy-menu-vertical li.toctree-l6 a, + .wy-menu-vertical li.toctree-l7 a, + .wy-menu-vertical li.toctree-l8 a, + .wy-menu-vertical li.toctree-l9 a, + .wy-menu-vertical li.toctree-l10 a { + color: rgb(192, 186, 178); + } + .wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l4 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l5 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l6 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l7 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l8 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l9 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l10 a:hover span.toctree-expand { + color: rgb(152, 143, 129); + } + .wy-menu-vertical li.toctree-l2.current > a, + .wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a { + background-image: initial; + background-color: rgb(54, 59, 61); + } + .wy-menu-vertical li.toctree-l2 span.toctree-expand { + color: rgb(174, 167, 156); + } + .wy-menu-vertical li.toctree-l3.current > a, + .wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a { + background-image: initial; + background-color: rgb(61, 66, 69); + } + .wy-menu-vertical li.toctree-l3 span.toctree-expand { + color: rgb(166, 158, 146); + } + .wy-menu-vertical li ul li a { + color: rgb(208, 204, 198); + } + .wy-menu-vertical a { + color: rgb(208, 204, 198); + } + .wy-menu-vertical a:hover { + background-color: rgb(57, 62, 64); + } + .wy-menu-vertical a:hover span.toctree-expand { + color: rgb(208, 204, 198); + } + .wy-menu-vertical a:active { + background-color: rgb(33, 102, 148); + color: rgb(232, 230, 227); + } + .wy-menu-vertical a:active span.toctree-expand { + color: rgb(232, 230, 227); + } + .wy-side-nav-search { + background-color: rgb(33, 102, 148); + color: rgb(230, 228, 225); + } + .wy-side-nav-search input[type="text"] { + border-color: rgb(35, 111, 160); + } + .wy-side-nav-search img { + background-color: rgb(33, 102, 148); + } + .wy-side-nav-search .wy-dropdown > a, + .wy-side-nav-search > a { + color: rgb(230, 228, 225); + } + .wy-side-nav-search .wy-dropdown > a:hover, + .wy-side-nav-search > a:hover { + background-image: initial; + background-color: rgba(24, 26, 27, 0.1); + } + .wy-side-nav-search .wy-dropdown > a img.logo, + .wy-side-nav-search > a img.logo { + background-image: initial; + background-color: transparent; + } + .wy-side-nav-search > div.version { + color: rgba(232, 230, 227, 0.3); + } + .wy-nav .wy-menu-vertical header { + color: rgb(84, 164, 217); + } + .wy-nav .wy-menu-vertical a { + color: rgb(184, 178, 169); + } + .wy-nav .wy-menu-vertical a:hover { + background-color: rgb(33, 102, 148); + color: rgb(232, 230, 227); + } + .wy-body-for-nav { + background-image: initial; + background-color: rgb(26, 28, 29); + } + .wy-nav-side { + color: rgb(169, 161, 150); + background-image: initial; + background-color: rgb(38, 41, 43); + } + .wy-nav-top { + background-image: initial; + background-color: rgb(33, 102, 148); + color: rgb(232, 230, 227); + } + .wy-nav-top a { + color: rgb(232, 230, 227); + } + .wy-nav-top img { + background-color: rgb(33, 102, 148); + } + .wy-nav-content-wrap { + background-image: initial; + background-color: rgb(26, 28, 29); + } + .wy-body-mask { + background-image: initial; + background-color: rgba(0, 0, 0, 0.2); + } + footer { + color: rgb(152, 143, 129); + } + .rst-content footer span.commit tt, + footer span.commit .rst-content tt, + footer span.commit code { + background-image: none; + background-color: initial; + border-color: initial; + color: rgb(152, 143, 129); + } + #search-results .search li { + border-bottom-color: rgb(56, 61, 63); + } + #search-results .search li:first-child { + border-top-color: rgb(56, 61, 63); + } + #search-results .context { + color: rgb(152, 143, 129); + } + .wy-body-for-nav { + background-image: initial; + background-color: rgb(26, 28, 29); + } + @media screen and (min-width: 1100px) { + .wy-nav-content-wrap { + background-image: initial; + background-color: rgba(0, 0, 0, 0.05); + } + .wy-nav-content { + background-image: initial; + background-color: rgb(26, 28, 29); + } + } + .rst-versions { + color: rgb(230, 228, 225); + background-image: initial; + background-color: rgb(23, 24, 25); + } + .rst-versions a { + color: rgb(84, 164, 217); + text-decoration-color: initial; + } + .rst-versions .rst-current-version { + background-color: rgb(29, 31, 32); + color: rgb(92, 218, 145); + } + .rst-content .code-block-caption .rst-versions .rst-current-version .headerlink, + .rst-content .rst-versions .rst-current-version .admonition-title, + .rst-content code.download .rst-versions .rst-current-version span:first-child, + .rst-content dl dt .rst-versions .rst-current-version .headerlink, + .rst-content h1 .rst-versions .rst-current-version .headerlink, + .rst-content h2 .rst-versions .rst-current-version .headerlink, + .rst-content h3 .rst-versions .rst-current-version .headerlink, + .rst-content h4 .rst-versions .rst-current-version .headerlink, + .rst-content h5 .rst-versions .rst-current-version .headerlink, + .rst-content h6 .rst-versions .rst-current-version .headerlink, + .rst-content p.caption .rst-versions .rst-current-version .headerlink, + .rst-content table > caption .rst-versions .rst-current-version .headerlink, + .rst-content tt.download .rst-versions .rst-current-version span:first-child, + .rst-versions .rst-current-version .fa, + .rst-versions .rst-current-version .icon, + .rst-versions .rst-current-version .rst-content .admonition-title, + .rst-versions .rst-current-version .rst-content .code-block-caption .headerlink, + .rst-versions .rst-current-version .rst-content code.download span:first-child, + .rst-versions .rst-current-version .rst-content dl dt .headerlink, + .rst-versions .rst-current-version .rst-content h1 .headerlink, + .rst-versions .rst-current-version .rst-content h2 .headerlink, + .rst-versions .rst-current-version .rst-content h3 .headerlink, + .rst-versions .rst-current-version .rst-content h4 .headerlink, + .rst-versions .rst-current-version .rst-content h5 .headerlink, + .rst-versions .rst-current-version .rst-content h6 .headerlink, + .rst-versions .rst-current-version .rst-content p.caption .headerlink, + .rst-versions .rst-current-version .rst-content table > caption .headerlink, + .rst-versions .rst-current-version .rst-content tt.download span:first-child, + .rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand, + .wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand { + color: rgb(230, 228, 225); + } + .rst-versions .rst-current-version.rst-out-of-date { + background-color: rgb(162, 33, 20); + color: rgb(232, 230, 227); + } + .rst-versions .rst-current-version.rst-active-old-version { + background-color: rgb(192, 156, 11); + color: rgb(232, 230, 227); + } + .rst-versions .rst-other-versions { + color: rgb(152, 143, 129); + } + .rst-versions .rst-other-versions hr { + border-right-color: initial; + border-bottom-color: initial; + border-left-color: initial; + border-top-color: rgb(119, 111, 98); + } + .rst-versions .rst-other-versions dd a { + color: rgb(230, 228, 225); + } + .rst-versions.rst-badge { + border-color: initial; + } + .rst-content abbr[title] { + text-decoration-color: initial; + } + .rst-content.style-external-links a.reference.external::after { + color: rgb(184, 178, 169); + } + .rst-content div[class^="highlight"], + .rst-content pre.literal-block { + border-color: rgb(56, 61, 63); + } + .rst-content div[class^="highlight"] div[class^="highlight"], .rst-content pre.literal-block div[class^="highlight"] { + border-color: initial; + } + .rst-content .linenodiv pre { + border-right-color: rgb(54, 59, 61); + } + .rst-content .admonition table { + border-color: rgba(140, 130, 115, 0.1); + } + .rst-content .admonition table td, + .rst-content .admonition table th { + background-image: initial !important; + background-color: transparent !important; + border-color: rgba(140, 130, 115, 0.1) !important; + } + .rst-content .section ol.loweralpha, + .rst-content .section ol.loweralpha > li { + list-style-image: initial; + } + .rst-content .section ol.upperalpha, + .rst-content .section ol.upperalpha > li { + list-style-image: initial; + } + .rst-content .toc-backref { + color: rgb(192, 186, 178); + } + .rst-content .sidebar { + background-image: initial; + background-color: rgb(27, 36, 36); + border-color: rgb(56, 61, 63); + } + .rst-content .sidebar .sidebar-title { + background-image: initial; + background-color: rgb(40, 43, 45); + } + .rst-content .highlighted { + background-image: initial; + background-color: rgb(192, 156, 11); + box-shadow: rgb(192, 156, 11) 0px 0px 0px 2px; + } + html.writer-html4 .rst-content table.docutils.citation, + html.writer-html4 .rst-content table.docutils.footnote { + background-image: none; + background-color: initial; + border-color: initial; + } + html.writer-html4 .rst-content table.docutils.citation td, + html.writer-html4 .rst-content table.docutils.citation tr, + html.writer-html4 .rst-content table.docutils.footnote td, + html.writer-html4 .rst-content table.docutils.footnote tr { + border-color: initial; + background-color: transparent !important; + } + .rst-content table.docutils.footnote, + html.writer-html4 .rst-content table.docutils.citation, + html.writer-html5 .rst-content dl.footnote { + color: rgb(152, 143, 129); + } + .rst-content table.docutils.footnote code, + .rst-content table.docutils.footnote tt, + html.writer-html4 .rst-content table.docutils.citation code, + html.writer-html4 .rst-content table.docutils.citation tt, + html.writer-html5 .rst-content dl.footnote code, + html.writer-html5 .rst-content dl.footnote tt { + color: rgb(178, 172, 162); + } + .rst-content table.docutils th { + border-color: rgb(56, 61, 63); + } + html.writer-html5 .rst-content table.docutils th { + border-color: rgb(56, 61, 63); + } + .rst-content table.field-list, + .rst-content table.field-list td { + border-color: initial; + } + .rst-content code, + .rst-content tt { + color: rgb(232, 230, 227); + } + .rst-content code.literal, + .rst-content tt.literal { + /* Manually overridden */ + color: rgb(228, 138, 128); + /*color: rgb(233, 88, 73);*/ + } + .rst-content code.xref, + .rst-content tt.xref, + a .rst-content code, + a .rst-content tt { + color: rgb(192, 186, 178); + } + .rst-content a code, + .rst-content a tt { + color: rgb(84, 164, 217); + } + html.writer-html4 .rst-content dl:not(.docutils) > dt, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) > dt { + background-image: initial; + background-color: rgb(32, 35, 36); + color: rgb(84, 164, 217); + border-top-color: rgb(28, 89, 128); + } + html.writer-html4 .rst-content dl:not(.docutils) > dt::before, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) > dt::before { + color: rgb(109, 178, 223); + } + html.writer-html4 .rst-content dl:not(.docutils) > dt .headerlink, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) > dt .headerlink { + color: rgb(192, 186, 178); + } + html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list) > dt, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list) > dt { + border-top-color: initial; + border-right-color: initial; + border-bottom-color: initial; + border-left-color: rgb(62, 68, 70); + background-image: initial; + background-color: rgb(32, 35, 37); + color: rgb(178, 172, 162); + } + html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list) > dt .headerlink, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list) > dt .headerlink { + color: rgb(192, 186, 178); + } + html.writer-html4 .rst-content dl:not(.docutils) code.descclassname, + html.writer-html4 .rst-content dl:not(.docutils) code.descname, + html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname, + html.writer-html4 .rst-content dl:not(.docutils) tt.descname, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname { + background-color: transparent; + border-color: initial; + } + html.writer-html4 .rst-content dl:not(.docutils) .optional, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional { + color: rgb(232, 230, 227); + } + .rst-content .viewcode-back, + .rst-content .viewcode-link { + color: rgb(92, 218, 145); + } + .rst-content code.download, + .rst-content tt.download { + background-image: inherit; + background-color: inherit; + color: inherit; + border-color: inherit; + } + .rst-content .guilabel { + border-color: rgb(27, 84, 122); + background-image: initial; + background-color: rgb(32, 35, 36); + } + span[id*="MathJax-Span"] { + color: rgb(192, 186, 178); + } + td.linenos pre { + color: rgb(232, 230, 227); + background-color: rgb(32, 35, 37); + } + span.linenos { + color: rgb(232, 230, 227); + background-color: rgb(32, 35, 37); + } + td.linenos pre.special { + color: rgb(232, 230, 227); + background-color: rgb(89, 89, 0); + } + span.linenos.special { + color: rgb(232, 230, 227); + background-color: rgb(89, 89, 0); + } + .highlight .hll { + background-color: rgb(82, 82, 0); + } + .highlight { + background-image: initial; + /* Manually overridden */ + background-color: rgb(44 47 37); + /*background-color: rgb(61, 82, 0);*/ + } + .highlight .c { + color: rgb(119, 179, 195); + } + .highlight .err { + border-color: rgb(179, 0, 0); + } + .highlight .k { + color: rgb(126, 255, 163); + } + .highlight .o { + color: rgb(168, 160, 149); + } + .highlight .ch { + color: rgb(119, 179, 195); + } + .highlight .cm { + color: rgb(119, 179, 195); + } + .highlight .cp { + color: rgb(126, 255, 163); + } + .highlight .cpf { + color: rgb(119, 179, 195); + } + .highlight .c1 { + color: rgb(119, 179, 195); + } + .highlight .cs { + color: rgb(119, 179, 195); + background-color: rgb(60, 0, 0); + } + .highlight .gd { + color: rgb(255, 92, 92); + } + .highlight .gr { + color: rgb(255, 26, 26); + } + .highlight .gh { + color: rgb(127, 174, 255); + } + .highlight .gi { + color: rgb(92, 255, 92); + } + .highlight .go { + color: rgb(200, 195, 188); + } + .highlight .gp { + color: rgb(246, 147, 68); + } + .highlight .gu { + color: rgb(255, 114, 255); + } + .highlight .gt { + color: rgb(71, 160, 255); + } + .highlight .kc { + color: rgb(126, 255, 163); + } + .highlight .kd { + color: rgb(126, 255, 163); + } + .highlight .kn { + color: rgb(126, 255, 163); + } + .highlight .kp { + color: rgb(126, 255, 163); + } + .highlight .kr { + color: rgb(126, 255, 163); + } + .highlight .kt { + color: rgb(255, 137, 103); + } + .highlight .m { + color: rgb(125, 222, 174); + } + .highlight .s { + color: rgb(123, 166, 202); + } + .highlight .na { + color: rgb(123, 166, 202); + } + .highlight .nb { + color: rgb(126, 255, 163); + } + .highlight .nc { + color: rgb(81, 194, 242); + } + .highlight .no { + color: rgb(103, 177, 215); + } + .highlight .nd { + color: rgb(178, 172, 162); + } + .highlight .ni { + color: rgb(217, 100, 73); + } + .highlight .ne { + color: rgb(126, 255, 163); + } + .highlight .nf { + color: rgb(131, 186, 249); + } + .highlight .nl { + color: rgb(137, 193, 255); + } + .highlight .nn { + color: rgb(81, 194, 242); + } + .highlight .nt { + color: rgb(138, 191, 249); + } + .highlight .nv { + color: rgb(190, 103, 215); + } + .highlight .ow { + color: rgb(126, 255, 163); + } + .highlight .w { + color: rgb(189, 183, 175); + } + .highlight .mb { + color: rgb(125, 222, 174); + } + .highlight .mf { + color: rgb(125, 222, 174); + } + .highlight .mh { + color: rgb(125, 222, 174); + } + .highlight .mi { + color: rgb(125, 222, 174); + } + .highlight .mo { + color: rgb(125, 222, 174); + } + .highlight .sa { + color: rgb(123, 166, 202); + } + .highlight .sb { + color: rgb(123, 166, 202); + } + .highlight .sc { + color: rgb(123, 166, 202); + } + .highlight .dl { + color: rgb(123, 166, 202); + } + .highlight .sd { + color: rgb(123, 166, 202); + } + .highlight .s2 { + color: rgb(123, 166, 202); + } + .highlight .se { + color: rgb(123, 166, 202); + } + .highlight .sh { + color: rgb(123, 166, 202); + } + .highlight .si { + color: rgb(117, 168, 209); + } + .highlight .sx { + color: rgb(246, 147, 68); + } + .highlight .sr { + color: rgb(133, 182, 224); + } + .highlight .s1 { + color: rgb(123, 166, 202); + } + .highlight .ss { + color: rgb(188, 230, 128); + } + .highlight .bp { + color: rgb(126, 255, 163); + } + .highlight .fm { + color: rgb(131, 186, 249); + } + .highlight .vc { + color: rgb(190, 103, 215); + } + .highlight .vg { + color: rgb(190, 103, 215); + } + .highlight .vi { + color: rgb(190, 103, 215); + } + .highlight .vm { + color: rgb(190, 103, 215); + } + .highlight .il { + color: rgb(125, 222, 174); + } + @media (prefers-color-scheme: dark) { + html { + background-color: rgb(19, 21, 22) !important; + } + html, + body, + input, + textarea, + select, + button { + background-color: rgb(19, 21, 22); + } + html, + body, + input, + textarea, + select, + button { + border-color: rgb(106, 98, 87); + color: rgb(216, 212, 207); + } + a { + color: rgb(61, 165, 255); + } + table { + border-color: rgb(111, 103, 91); + } + ::placeholder { + color: rgb(178, 171, 161); + } + input:-webkit-autofill, + textarea:-webkit-autofill, + select:-webkit-autofill { + background-color: rgb(68, 73, 0) !important; + color: rgb(216, 212, 207) !important; + } + ::-webkit-scrollbar { + background-color: rgb(26, 28, 29); + color: rgb(173, 166, 156); + } + ::-webkit-scrollbar-thumb { + background-color: rgb(55, 60, 62); + } + ::-webkit-scrollbar-thumb:hover { + background-color: rgb(70, 75, 78); + } + ::-webkit-scrollbar-thumb:active { + background-color: rgb(58, 62, 65); + } + ::-webkit-scrollbar-corner { + background-color: rgb(19, 21, 22); + } + ::selection { + background-color: rgb(0, 62, 136) !important; + color: rgb(216, 212, 207) !important; + } + :root { + --darkreader-neutral-background: #131516; + --darkreader-text--darkreader-neutral-text: #cdc8c2; + --darkreader-selection-background: #004daa; + --darkreader-selection-text: #e8e6e3; + } + a:active, + a:hover { + outline-color: currentcolor; + } + abbr[title] { + border-bottom-color: currentcolor; + } + ins { + background-color: rgb(90, 90, 0); + background-image: none; + text-decoration-color: currentcolor; + } + ins, + mark { + color: rgb(216, 212, 207); + } + mark { + background-color: rgb(163, 163, 0); + background-image: none; + } + dl, + ol, + ul { + list-style-image: none; + } + li { + list-style-image: none; + } + img { + border-color: currentcolor; + } + .chromeframe { + background-color: rgb(42, 46, 47); + background-image: none; + color: rgb(216, 212, 207); + } + .ir { + border-color: currentcolor; + background-color: transparent; + } + .visuallyhidden { + border-color: currentcolor; + } + .fa-border { + border-color: rgb(122, 113, 100); + } + .fa-inverse { + color: rgb(216, 212, 207); + } + .sr-only { + border-color: currentcolor; + } + .fa::before, + .icon::before, + .rst-content .admonition-title::before, + .rst-content .code-block-caption .headerlink::before, + .rst-content code.download span:first-child::before, + .rst-content dl dt .headerlink::before, + .rst-content h1 .headerlink::before, + .rst-content h2 .headerlink::before, + .rst-content h3 .headerlink::before, + .rst-content h4 .headerlink::before, + .rst-content h5 .headerlink::before, + .rst-content h6 .headerlink::before, + .rst-content p.caption .headerlink::before, + .rst-content table > caption .headerlink::before, + .rst-content tt.download span:first-child::before, + .wy-dropdown .caret::before, + .wy-inline-validate.wy-inline-validate-danger .wy-input-context::before, + .wy-inline-validate.wy-inline-validate-info .wy-input-context::before, + .wy-inline-validate.wy-inline-validate-success .wy-input-context::before, + .wy-inline-validate.wy-inline-validate-warning .wy-input-context::before, + .wy-menu-vertical li.current > a span.toctree-expand::before, + .wy-menu-vertical li.on a span.toctree-expand::before, + .wy-menu-vertical li span.toctree-expand::before { + text-decoration-color: inherit; + } + .rst-content .code-block-caption a .headerlink, + .rst-content a .admonition-title, + .rst-content code.download a span:first-child, + .rst-content dl dt a .headerlink, + .rst-content h1 a .headerlink, + .rst-content h2 a .headerlink, + .rst-content h3 a .headerlink, + .rst-content h4 a .headerlink, + .rst-content h5 a .headerlink, + .rst-content h6 a .headerlink, + .rst-content p.caption a .headerlink, + .rst-content table > caption a .headerlink, + .rst-content tt.download a span:first-child, + .wy-menu-vertical li.current > a span.toctree-expand, + .wy-menu-vertical li.on a span.toctree-expand, + .wy-menu-vertical li a span.toctree-expand, + a .fa, + a .icon, + a .rst-content .admonition-title, + a .rst-content .code-block-caption .headerlink, + a .rst-content code.download span:first-child, + a .rst-content dl dt .headerlink, + a .rst-content h1 .headerlink, + a .rst-content h2 .headerlink, + a .rst-content h3 .headerlink, + a .rst-content h4 .headerlink, + a .rst-content h5 .headerlink, + a .rst-content h6 .headerlink, + a .rst-content p.caption .headerlink, + a .rst-content table > caption .headerlink, + a .rst-content tt.download span:first-child, + a .wy-menu-vertical li span.toctree-expand { + text-decoration-color: inherit; + } + .rst-content .admonition, + .rst-content .admonition-todo, + .rst-content .attention, + .rst-content .caution, + .rst-content .danger, + .rst-content .error, + .rst-content .hint, + .rst-content .important, + .rst-content .note, + .rst-content .seealso, + .rst-content .tip, + .rst-content .warning, + .wy-alert { + background-color: rgb(26, 28, 29); + background-image: none; + } + .rst-content .admonition-title, + .wy-alert-title { + color: rgb(216, 212, 207); + background-color: rgb(23, 73, 105); + background-image: none; + } + .rst-content .danger, + .rst-content .error, + .rst-content .wy-alert-danger.admonition, + .rst-content .wy-alert-danger.admonition-todo, + .rst-content .wy-alert-danger.attention, + .rst-content .wy-alert-danger.caution, + .rst-content .wy-alert-danger.hint, + .rst-content .wy-alert-danger.important, + .rst-content .wy-alert-danger.note, + .rst-content .wy-alert-danger.seealso, + .rst-content .wy-alert-danger.tip, + .rst-content .wy-alert-danger.warning, + .wy-alert.wy-alert-danger { + background-color: rgb(42, 10, 6); + background-image: none; + } + .rst-content .danger .admonition-title, + .rst-content .danger .wy-alert-title, + .rst-content .error .admonition-title, + .rst-content .error .wy-alert-title, + .rst-content .wy-alert-danger.admonition-todo .admonition-title, + .rst-content .wy-alert-danger.admonition-todo .wy-alert-title, + .rst-content .wy-alert-danger.admonition .admonition-title, + .rst-content .wy-alert-danger.admonition .wy-alert-title, + .rst-content .wy-alert-danger.attention .admonition-title, + .rst-content .wy-alert-danger.attention .wy-alert-title, + .rst-content .wy-alert-danger.caution .admonition-title, + .rst-content .wy-alert-danger.caution .wy-alert-title, + .rst-content .wy-alert-danger.hint .admonition-title, + .rst-content .wy-alert-danger.hint .wy-alert-title, + .rst-content .wy-alert-danger.important .admonition-title, + .rst-content .wy-alert-danger.important .wy-alert-title, + .rst-content .wy-alert-danger.note .admonition-title, + .rst-content .wy-alert-danger.note .wy-alert-title, + .rst-content .wy-alert-danger.seealso .admonition-title, + .rst-content .wy-alert-danger.seealso .wy-alert-title, + .rst-content .wy-alert-danger.tip .admonition-title, + .rst-content .wy-alert-danger.tip .wy-alert-title, + .rst-content .wy-alert-danger.warning .admonition-title, + .rst-content .wy-alert-danger.warning .wy-alert-title, + .rst-content .wy-alert.wy-alert-danger .admonition-title, + .wy-alert.wy-alert-danger .rst-content .admonition-title, + .wy-alert.wy-alert-danger .wy-alert-title { + background-color: rgb(86, 18, 10); + background-image: none; + } + .rst-content .admonition-todo, + .rst-content .attention, + .rst-content .caution, + .rst-content .warning, + .rst-content .wy-alert-warning.admonition, + .rst-content .wy-alert-warning.danger, + .rst-content .wy-alert-warning.error, + .rst-content .wy-alert-warning.hint, + .rst-content .wy-alert-warning.important, + .rst-content .wy-alert-warning.note, + .rst-content .wy-alert-warning.seealso, + .rst-content .wy-alert-warning.tip, + .wy-alert.wy-alert-warning { + background-color: rgb(25, 27, 28); + background-image: none; + } + .rst-content .admonition-todo .admonition-title, + .rst-content .admonition-todo .wy-alert-title, + .rst-content .attention .admonition-title, + .rst-content .attention .wy-alert-title, + .rst-content .caution .admonition-title, + .rst-content .caution .wy-alert-title, + .rst-content .warning .admonition-title, + .rst-content .warning .wy-alert-title, + .rst-content .wy-alert-warning.admonition .admonition-title, + .rst-content .wy-alert-warning.admonition .wy-alert-title, + .rst-content .wy-alert-warning.danger .admonition-title, + .rst-content .wy-alert-warning.danger .wy-alert-title, + .rst-content .wy-alert-warning.error .admonition-title, + .rst-content .wy-alert-warning.error .wy-alert-title, + .rst-content .wy-alert-warning.hint .admonition-title, + .rst-content .wy-alert-warning.hint .wy-alert-title, + .rst-content .wy-alert-warning.important .admonition-title, + .rst-content .wy-alert-warning.important .wy-alert-title, + .rst-content .wy-alert-warning.note .admonition-title, + .rst-content .wy-alert-warning.note .wy-alert-title, + .rst-content .wy-alert-warning.seealso .admonition-title, + .rst-content .wy-alert-warning.seealso .wy-alert-title, + .rst-content .wy-alert-warning.tip .admonition-title, + .rst-content .wy-alert-warning.tip .wy-alert-title, + .rst-content .wy-alert.wy-alert-warning .admonition-title, + .wy-alert.wy-alert-warning .rst-content .admonition-title, + .wy-alert.wy-alert-warning .wy-alert-title { + background-color: rgb(98, 52, 11); + background-image: none; + } + .rst-content .note, + .rst-content .seealso, + .rst-content .wy-alert-info.admonition, + .rst-content .wy-alert-info.admonition-todo, + .rst-content .wy-alert-info.attention, + .rst-content .wy-alert-info.caution, + .rst-content .wy-alert-info.danger, + .rst-content .wy-alert-info.error, + .rst-content .wy-alert-info.hint, + .rst-content .wy-alert-info.important, + .rst-content .wy-alert-info.tip, + .rst-content .wy-alert-info.warning, + .wy-alert.wy-alert-info { + background-color: rgb(26, 28, 29); + background-image: none; + } + .rst-content .note .admonition-title, + .rst-content .note .wy-alert-title, + .rst-content .seealso .admonition-title, + .rst-content .seealso .wy-alert-title, + .rst-content .wy-alert-info.admonition-todo .admonition-title, + .rst-content .wy-alert-info.admonition-todo .wy-alert-title, + .rst-content .wy-alert-info.admonition .admonition-title, + .rst-content .wy-alert-info.admonition .wy-alert-title, + .rst-content .wy-alert-info.attention .admonition-title, + .rst-content .wy-alert-info.attention .wy-alert-title, + .rst-content .wy-alert-info.caution .admonition-title, + .rst-content .wy-alert-info.caution .wy-alert-title, + .rst-content .wy-alert-info.danger .admonition-title, + .rst-content .wy-alert-info.danger .wy-alert-title, + .rst-content .wy-alert-info.error .admonition-title, + .rst-content .wy-alert-info.error .wy-alert-title, + .rst-content .wy-alert-info.hint .admonition-title, + .rst-content .wy-alert-info.hint .wy-alert-title, + .rst-content .wy-alert-info.important .admonition-title, + .rst-content .wy-alert-info.important .wy-alert-title, + .rst-content .wy-alert-info.tip .admonition-title, + .rst-content .wy-alert-info.tip .wy-alert-title, + .rst-content .wy-alert-info.warning .admonition-title, + .rst-content .wy-alert-info.warning .wy-alert-title, + .rst-content .wy-alert.wy-alert-info .admonition-title, + .wy-alert.wy-alert-info .rst-content .admonition-title, + .wy-alert.wy-alert-info .wy-alert-title { + background-color: rgb(23, 73, 105); + background-image: none; + } + .rst-content .hint, + .rst-content .important, + .rst-content .tip, + .rst-content .wy-alert-success.admonition, + .rst-content .wy-alert-success.admonition-todo, + .rst-content .wy-alert-success.attention, + .rst-content .wy-alert-success.caution, + .rst-content .wy-alert-success.danger, + .rst-content .wy-alert-success.error, + .rst-content .wy-alert-success.note, + .rst-content .wy-alert-success.seealso, + .rst-content .wy-alert-success.warning, + .wy-alert.wy-alert-success { + background-color: rgb(7, 53, 46); + background-image: none; + } + .rst-content .hint .admonition-title, + .rst-content .hint .wy-alert-title, + .rst-content .important .admonition-title, + .rst-content .important .wy-alert-title, + .rst-content .tip .admonition-title, + .rst-content .tip .wy-alert-title, + .rst-content .wy-alert-success.admonition-todo .admonition-title, + .rst-content .wy-alert-success.admonition-todo .wy-alert-title, + .rst-content .wy-alert-success.admonition .admonition-title, + .rst-content .wy-alert-success.admonition .wy-alert-title, + .rst-content .wy-alert-success.attention .admonition-title, + .rst-content .wy-alert-success.attention .wy-alert-title, + .rst-content .wy-alert-success.caution .admonition-title, + .rst-content .wy-alert-success.caution .wy-alert-title, + .rst-content .wy-alert-success.danger .admonition-title, + .rst-content .wy-alert-success.danger .wy-alert-title, + .rst-content .wy-alert-success.error .admonition-title, + .rst-content .wy-alert-success.error .wy-alert-title, + .rst-content .wy-alert-success.note .admonition-title, + .rst-content .wy-alert-success.note .wy-alert-title, + .rst-content .wy-alert-success.seealso .admonition-title, + .rst-content .wy-alert-success.seealso .wy-alert-title, + .rst-content .wy-alert-success.warning .admonition-title, + .rst-content .wy-alert-success.warning .wy-alert-title, + .rst-content .wy-alert.wy-alert-success .admonition-title, + .wy-alert.wy-alert-success .rst-content .admonition-title, + .wy-alert.wy-alert-success .wy-alert-title { + background-color: rgb(17, 120, 100); + background-image: none; + } + .rst-content .wy-alert-neutral.admonition, + .rst-content .wy-alert-neutral.admonition-todo, + .rst-content .wy-alert-neutral.attention, + .rst-content .wy-alert-neutral.caution, + .rst-content .wy-alert-neutral.danger, + .rst-content .wy-alert-neutral.error, + .rst-content .wy-alert-neutral.hint, + .rst-content .wy-alert-neutral.important, + .rst-content .wy-alert-neutral.note, + .rst-content .wy-alert-neutral.seealso, + .rst-content .wy-alert-neutral.tip, + .rst-content .wy-alert-neutral.warning, + .wy-alert.wy-alert-neutral { + background-color: rgb(22, 29, 29); + background-image: none; + } + .rst-content .wy-alert-neutral.admonition-todo .admonition-title, + .rst-content .wy-alert-neutral.admonition-todo .wy-alert-title, + .rst-content .wy-alert-neutral.admonition .admonition-title, + .rst-content .wy-alert-neutral.admonition .wy-alert-title, + .rst-content .wy-alert-neutral.attention .admonition-title, + .rst-content .wy-alert-neutral.attention .wy-alert-title, + .rst-content .wy-alert-neutral.caution .admonition-title, + .rst-content .wy-alert-neutral.caution .wy-alert-title, + .rst-content .wy-alert-neutral.danger .admonition-title, + .rst-content .wy-alert-neutral.danger .wy-alert-title, + .rst-content .wy-alert-neutral.error .admonition-title, + .rst-content .wy-alert-neutral.error .wy-alert-title, + .rst-content .wy-alert-neutral.hint .admonition-title, + .rst-content .wy-alert-neutral.hint .wy-alert-title, + .rst-content .wy-alert-neutral.important .admonition-title, + .rst-content .wy-alert-neutral.important .wy-alert-title, + .rst-content .wy-alert-neutral.note .admonition-title, + .rst-content .wy-alert-neutral.note .wy-alert-title, + .rst-content .wy-alert-neutral.seealso .admonition-title, + .rst-content .wy-alert-neutral.seealso .wy-alert-title, + .rst-content .wy-alert-neutral.tip .admonition-title, + .rst-content .wy-alert-neutral.tip .wy-alert-title, + .rst-content .wy-alert-neutral.warning .admonition-title, + .rst-content .wy-alert-neutral.warning .wy-alert-title, + .rst-content .wy-alert.wy-alert-neutral .admonition-title, + .wy-alert.wy-alert-neutral .rst-content .admonition-title, + .wy-alert.wy-alert-neutral .wy-alert-title { + color: rgb(188, 182, 173); + background-color: rgb(32, 35, 36); + background-image: none; + } + .rst-content .wy-alert-neutral.admonition-todo a, + .rst-content .wy-alert-neutral.admonition a, + .rst-content .wy-alert-neutral.attention a, + .rst-content .wy-alert-neutral.caution a, + .rst-content .wy-alert-neutral.danger a, + .rst-content .wy-alert-neutral.error a, + .rst-content .wy-alert-neutral.hint a, + .rst-content .wy-alert-neutral.important a, + .rst-content .wy-alert-neutral.note a, + .rst-content .wy-alert-neutral.seealso a, + .rst-content .wy-alert-neutral.tip a, + .rst-content .wy-alert-neutral.warning a, + .wy-alert.wy-alert-neutral a { + color: rgb(94, 169, 219); + } + .wy-tray-container li { + background-color: transparent; + background-image: none; + color: rgb(216, 212, 207); + box-shadow: rgba(0, 0, 0, 0.1) 0px 5px 5px 0px; + } + .wy-tray-container li.wy-tray-item-success { + background-color: rgb(25, 111, 62); + background-image: none; + } + .wy-tray-container li.wy-tray-item-info { + background-color: rgb(26, 82, 118); + background-image: none; + } + .wy-tray-container li.wy-tray-item-warning { + background-color: rgb(142, 75, 16); + background-image: none; + } + .wy-tray-container li.wy-tray-item-danger { + background-color: rgb(130, 26, 16); + background-image: none; + } + .btn { + color: rgb(216, 212, 207); + border-color: rgba(84, 91, 95, 0.1); + background-color: rgb(25, 111, 62); + text-decoration-color: currentcolor; + box-shadow: rgba(19, 21, 22, 0.5) 0px 1px 2px -1px inset, + rgba(0, 0, 0, 0.1) 0px -2px 0px 0px inset; + } + .btn-hover { + background-color: rgb(30, 91, 132); + background-image: none; + color: rgb(216, 212, 207); + } + .btn:hover { + background-color: rgb(28, 125, 69); + background-image: none; + color: rgb(216, 212, 207); + } + .btn:focus { + background-color: rgb(28, 125, 69); + background-image: none; + outline-color: currentcolor; + } + .btn:active { + box-shadow: rgba(0, 0, 0, 0.05) 0px -1px 0px 0px inset, + rgba(0, 0, 0, 0.1) 0px 2px 0px 0px inset; + } + .btn:visited { + color: rgb(216, 212, 207); + } + .btn-disabled, + .btn-disabled:active, + .btn-disabled:focus, + .btn-disabled:hover, + .btn:disabled { + background-image: none; + box-shadow: none; + } + .btn-info { + background-color: rgb(26, 82, 118) !important; + } + .btn-info:hover { + background-color: rgb(30, 91, 132) !important; + } + .btn-neutral { + background-color: rgb(22, 29, 29) !important; + color: rgb(188, 182, 173) !important; + } + .btn-neutral:hover { + color: rgb(188, 182, 173); + background-color: rgb(27, 35, 35) !important; + } + .btn-neutral:visited { + color: rgb(188, 182, 173) !important; + } + .btn-success { + background-color: rgb(25, 111, 62) !important; + } + .btn-success:hover { + background-color: rgb(22, 98, 54) !important; + } + .btn-danger { + background-color: rgb(130, 26, 16) !important; + } + .btn-danger:hover { + background-color: rgb(119, 24, 14) !important; + } + .btn-warning { + background-color: rgb(142, 75, 16) !important; + } + .btn-warning:hover { + background-color: rgb(132, 70, 14) !important; + } + .btn-invert { + background-color: rgb(21, 22, 23); + } + .btn-invert:hover { + background-color: rgb(28, 31, 32) !important; + } + .btn-link { + color: rgb(94, 169, 219); + box-shadow: none; + background-color: transparent !important; + border-color: transparent !important; + } + .btn-link:active, + .btn-link:hover { + box-shadow: none; + background-color: transparent !important; + color: rgb(90, 168, 218) !important; + } + .btn-link:visited { + color: rgb(170, 113, 192); + } + .wy-dropdown-menu { + background-color: rgb(21, 22, 23); + background-image: none; + border-color: rgb(119, 111, 98); + box-shadow: rgba(0, 0, 0, 0.1) 0px 2px 2px 0px; + } + .wy-dropdown-menu > dd > a { + color: rgb(188, 182, 173); + } + .wy-dropdown-menu > dd > a:hover { + background-color: rgb(26, 82, 118); + background-image: none; + color: rgb(216, 212, 207); + } + .wy-dropdown-menu > dd.divider { + border-top-color: rgb(119, 111, 98); + } + .wy-dropdown-menu > dd.call-to-action { + background-color: rgb(32, 35, 36); + background-image: none; + } + .wy-dropdown-menu > dd.call-to-action:hover { + background-color: rgb(32, 35, 36); + background-image: none; + } + .wy-dropdown-menu > dd.call-to-action .btn { + color: rgb(216, 212, 207); + } + .wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu { + background-color: rgb(21, 22, 23); + background-image: none; + } + .wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover { + background-color: rgb(26, 82, 118); + background-image: none; + color: rgb(216, 212, 207); + } + .wy-dropdown-arrow::before { + border-bottom-color: rgb(122, 113, 100); + border-left-color: transparent; + border-right-color: transparent; + } + fieldset, + legend { + border-color: currentcolor; + } + label { + color: rgb(193, 188, 180); + } + .wy-control-group.wy-control-group-required > label::after { + color: rgb(234, 96, 82); + } + .wy-form-message-inline { + color: rgb(171, 164, 153); + } + .wy-form-message { + color: rgb(171, 164, 153); + } + input[type="color"], input[type="date"], input[type="datetime-local"], input[type="datetime"], input[type="email"], input[type="month"], input[type="number"], input[type="password"], input[type="search"], input[type="tel"], input[type="text"], input[type="time"], input[type="url"], input[type="week"] { + border-color: rgb(118, 110, 97); + box-shadow: rgb(35, 38, 39) 0px 1px 3px inset; + } + input[type="color"]:focus, input[type="date"]:focus, input[type="datetime-local"]:focus, input[type="datetime"]:focus, input[type="email"]:focus, input[type="month"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="time"]:focus, input[type="url"]:focus, input[type="week"]:focus { + outline-color: currentcolor; + border-color: rgb(103, 96, 85); + } + input.no-focus:focus { + border-color: rgb(118, 110, 97) !important; + } + input[type="checkbox"]:focus, input[type="file"]:focus, input[type="radio"]:focus { + outline-color: rgb(15, 126, 186); + } + input[type="color"][disabled], input[type="date"][disabled], input[type="datetime-local"][disabled], input[type="datetime"][disabled], input[type="email"][disabled], input[type="month"][disabled], input[type="number"][disabled], input[type="password"][disabled], input[type="search"][disabled], input[type="tel"][disabled], input[type="text"][disabled], input[type="time"][disabled], input[type="url"][disabled], input[type="week"][disabled] { + background-color: rgb(21, 23, 24); + } + input:focus:invalid, + select:focus:invalid, + textarea:focus:invalid { + color: rgb(234, 96, 82); + border-color: rgb(183, 38, 22); + } + input:focus:invalid:focus, + select:focus:invalid:focus, + textarea:focus:invalid:focus { + border-color: rgb(183, 38, 22); + } + input[type="checkbox"]:focus:invalid:focus, input[type="file"]:focus:invalid:focus, input[type="radio"]:focus:invalid:focus { + outline-color: rgb(183, 38, 22); + } + select, + textarea { + border-color: rgb(118, 110, 97); + box-shadow: rgb(35, 38, 39) 0px 1px 3px inset; + } + select { + border-color: rgb(118, 110, 97); + background-color: rgb(19, 21, 22); + } + select:focus, + textarea:focus { + outline-color: currentcolor; + } + input[readonly], + select[disabled], + select[readonly], + textarea[disabled], + textarea[readonly] { + background-color: rgb(21, 23, 24); + } + .wy-checkbox, + .wy-radio { + color: rgb(188, 182, 173); + } + .wy-input-prefix .wy-input-context, + .wy-input-suffix .wy-input-context { + background-color: rgb(22, 29, 29); + border-color: rgb(118, 110, 97); + color: rgb(171, 164, 153); + } + .wy-input-suffix .wy-input-context { + border-left-color: currentcolor; + } + .wy-input-prefix .wy-input-context { + border-right-color: currentcolor; + } + .wy-switch::before { + background-color: rgb(42, 46, 47); + background-image: none; + } + .wy-switch::after { + background-color: rgb(66, 71, 74); + background-image: none; + } + .wy-switch span { + color: rgb(193, 188, 180); + } + .wy-switch.active::before { + background-color: rgb(19, 85, 46); + background-image: none; + } + .wy-switch.active::after { + background-color: rgb(25, 111, 62); + background-image: none; + } + .wy-control-group.wy-control-group-error .wy-form-message, + .wy-control-group.wy-control-group-error > label { + color: rgb(234, 96, 82); + } + .wy-control-group.wy-control-group-error input[type="color"], .wy-control-group.wy-control-group-error input[type="date"], .wy-control-group.wy-control-group-error input[type="datetime-local"], .wy-control-group.wy-control-group-error input[type="datetime"], .wy-control-group.wy-control-group-error input[type="email"], .wy-control-group.wy-control-group-error input[type="month"], .wy-control-group.wy-control-group-error input[type="number"], .wy-control-group.wy-control-group-error input[type="password"], .wy-control-group.wy-control-group-error input[type="search"], .wy-control-group.wy-control-group-error input[type="tel"], .wy-control-group.wy-control-group-error input[type="text"], .wy-control-group.wy-control-group-error input[type="time"], .wy-control-group.wy-control-group-error input[type="url"], .wy-control-group.wy-control-group-error input[type="week"], + .wy-control-group.wy-control-group-error textarea { + border-color: rgb(183, 38, 22); + } + .wy-inline-validate.wy-inline-validate-success .wy-input-context { + color: rgb(99, 220, 150); + } + .wy-inline-validate.wy-inline-validate-danger .wy-input-context { + color: rgb(234, 96, 82); + } + .wy-inline-validate.wy-inline-validate-warning .wy-input-context { + color: rgb(234, 146, 69); + } + .wy-inline-validate.wy-inline-validate-info .wy-input-context { + color: rgb(94, 169, 219); + } + .rst-content table.docutils caption, + .rst-content table.field-list caption, + .wy-table caption { + color: rgb(216, 212, 207); + } + .rst-content table.docutils thead, + .rst-content table.field-list thead, + .wy-table thead { + color: rgb(216, 212, 207); + } + .rst-content table.docutils thead th, + .rst-content table.field-list thead th, + .wy-table thead th { + border-bottom-color: rgb(120, 112, 99); + } + .rst-content table.docutils td, + .rst-content table.field-list td, + .wy-table td { + background-color: transparent; + } + .wy-table-secondary { + color: rgb(160, 151, 139); + } + .wy-table-tertiary { + color: rgb(160, 151, 139); + } + .rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td, + .wy-table-backed, + .wy-table-odd td, + .wy-table-striped tr:nth-child(2n-1) td { + background-color: rgb(22, 29, 29); + } + .rst-content table.docutils, + .wy-table-bordered-all { + border-color: rgb(120, 112, 99); + } + .rst-content table.docutils td, + .wy-table-bordered-all td { + border-bottom-color: rgb(120, 112, 99); + border-left-color: rgb(120, 112, 99); + } + .wy-table-bordered { + border-color: rgb(120, 112, 99); + } + .wy-table-bordered-rows td { + border-bottom-color: rgb(120, 112, 99); + } + .wy-table-horizontal td, + .wy-table-horizontal th { + border-bottom-color: rgb(120, 112, 99); + } + a { + color: rgb(94, 169, 219); + text-decoration-color: currentcolor; + } + a:hover { + color: rgb(82, 164, 217); + } + a:visited { + color: rgb(170, 113, 192); + } + body { + color: rgb(188, 182, 173); + background-color: rgb(26, 29, 30); + background-image: none; + } + .wy-text-strike { + text-decoration-color: currentcolor; + } + .wy-text-warning { + color: rgb(234, 146, 69) !important; + } + a.wy-text-warning:hover { + color: rgb(237, 160, 92) !important; + } + .wy-text-info { + color: rgb(94, 169, 219) !important; + } + a.wy-text-info:hover { + color: rgb(90, 168, 218) !important; + } + .wy-text-success { + color: rgb(99, 220, 150) !important; + } + a.wy-text-success:hover { + color: rgb(86, 217, 142) !important; + } + .wy-text-danger { + color: rgb(234, 96, 82) !important; + } + a.wy-text-danger:hover { + color: rgb(237, 118, 104) !important; + } + .wy-text-neutral { + color: rgb(188, 182, 173) !important; + } + a.wy-text-neutral:hover { + color: rgb(177, 170, 160) !important; + } + hr { + border-color: rgb(120, 112, 99) currentcolor currentcolor; + } + .rst-content code, + .rst-content tt, + code { + background-color: rgb(19, 21, 22); + background-image: none; + border-color: rgb(120, 112, 99); + color: rgb(234, 96, 82); + } + .rst-content .section ul, + .rst-content .toctree-wrapper ul, + .wy-plain-list-disc, + article ul { + list-style-image: none; + } + .rst-content .section ul li, + .rst-content .toctree-wrapper ul li, + .wy-plain-list-disc li, + article ul li { + list-style-image: none; + } + .rst-content .section ul li li, + .rst-content .toctree-wrapper ul li li, + .wy-plain-list-disc li li, + article ul li li { + list-style-image: none; + } + .rst-content .section ul li li li, + .rst-content .toctree-wrapper ul li li li, + .wy-plain-list-disc li li li, + article ul li li li { + list-style-image: none; + } + .rst-content .section ul li ol li, + .rst-content .toctree-wrapper ul li ol li, + .wy-plain-list-disc li ol li, + article ul li ol li { + list-style-image: none; + } + .rst-content .section ol, + .rst-content ol.arabic, + .wy-plain-list-decimal, + article ol { + list-style-image: none; + } + .rst-content .section ol li, + .rst-content ol.arabic li, + .wy-plain-list-decimal li, + article ol li { + list-style-image: none; + } + .rst-content .section ol li ul li, + .rst-content ol.arabic li ul li, + .wy-plain-list-decimal li ul li, + article ol li ul li { + list-style-image: none; + } + .rst-content .wy-breadcrumbs li tt, + .wy-breadcrumbs li .rst-content tt, + .wy-breadcrumbs li code { + border-color: currentcolor; + background-color: rgba(0, 0, 0, 0); + background-image: none; + } + .rst-content .wy-breadcrumbs li tt.literal, + .wy-breadcrumbs li .rst-content tt.literal, + .wy-breadcrumbs li code.literal { + color: rgb(188, 182, 173); + } + .wy-breadcrumbs-extra { + color: rgb(182, 176, 167); + } + .wy-menu a:hover { + text-decoration-color: currentcolor; + } + .wy-menu-horiz li:hover { + background-color: rgba(19, 21, 22, 0.1); + background-image: none; + } + .wy-menu-horiz li.divide-left { + border-left-color: rgb(104, 97, 86); + } + .wy-menu-horiz li.divide-right { + border-right-color: rgb(104, 97, 86); + } + .wy-menu-vertical header, + .wy-menu-vertical p.caption { + color: rgb(101, 173, 220); + } + .wy-menu-vertical li.divide-top { + border-top-color: rgb(104, 97, 86); + } + .wy-menu-vertical li.divide-bottom { + border-bottom-color: rgb(104, 97, 86); + } + .wy-menu-vertical li.current { + background-color: rgb(32, 35, 36); + background-image: none; + } + .wy-menu-vertical li.current a { + color: rgb(160, 151, 139); + border-right-color: rgb(118, 110, 97); + } + .wy-menu-vertical li.current a:hover { + background-color: rgb(38, 41, 42); + background-image: none; + } + .rst-content .wy-menu-vertical li tt, + .wy-menu-vertical li .rst-content tt, + .wy-menu-vertical li code { + border-color: currentcolor; + background-color: inherit; + background-image: inherit; + color: inherit; + } + .wy-menu-vertical li span.toctree-expand { + color: rgb(182, 175, 166); + } + .wy-menu-vertical li.current > a, + .wy-menu-vertical li.on a { + color: rgb(188, 182, 173); + background-color: rgb(21, 22, 23); + background-image: none; + border-color: currentcolor; + } + .wy-menu-vertical li.current > a:hover, + .wy-menu-vertical li.on a:hover { + background-color: rgb(21, 22, 23); + background-image: none; + } + .wy-menu-vertical li.current > a:hover span.toctree-expand, + .wy-menu-vertical li.on a:hover span.toctree-expand { + color: rgb(160, 151, 139); + } + .wy-menu-vertical li.current > a span.toctree-expand, + .wy-menu-vertical li.on a span.toctree-expand { + color: rgb(193, 188, 180); + } + .wy-menu-vertical li.toctree-l1.current > a { + border-bottom-color: rgb(118, 110, 97); + border-top-color: rgb(118, 110, 97); + } + .wy-menu-vertical li.toctree-l2 a, + .wy-menu-vertical li.toctree-l3 a, + .wy-menu-vertical li.toctree-l4 a, + .wy-menu-vertical li.toctree-l5 a, + .wy-menu-vertical li.toctree-l6 a, + .wy-menu-vertical li.toctree-l7 a, + .wy-menu-vertical li.toctree-l8 a, + .wy-menu-vertical li.toctree-l9 a, + .wy-menu-vertical li.toctree-l10 a { + color: rgb(188, 182, 173); + } + .wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l4 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l5 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l6 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l7 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l8 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l9 a:hover span.toctree-expand, + .wy-menu-vertical li.toctree-l10 a:hover span.toctree-expand { + color: rgb(160, 151, 139); + } + .wy-menu-vertical li.toctree-l2.current > a, + .wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a { + background-color: rgb(43, 47, 49); + background-image: none; + } + .wy-menu-vertical li.toctree-l2 span.toctree-expand { + color: rgb(175, 168, 158); + } + .wy-menu-vertical li.toctree-l3.current > a, + .wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a { + background-color: rgb(49, 53, 55); + background-image: none; + } + .wy-menu-vertical li.toctree-l3 span.toctree-expand { + color: rgb(169, 162, 151); + } + .wy-menu-vertical li ul li a { + color: rgb(199, 194, 187); + } + .wy-menu-vertical a { + color: rgb(199, 194, 187); + } + .wy-menu-vertical a:hover { + background-color: rgb(46, 49, 51); + } + .wy-menu-vertical a:hover span.toctree-expand { + color: rgb(199, 194, 187); + } + .wy-menu-vertical a:active { + background-color: rgb(26, 82, 118); + color: rgb(216, 212, 207); + } + .wy-menu-vertical a:active span.toctree-expand { + color: rgb(216, 212, 207); + } + .wy-side-nav-search { + background-color: rgb(26, 82, 118); + color: rgb(215, 211, 206); + } + .wy-side-nav-search input[type="text"] { + border-color: rgb(35, 112, 161); + } + .wy-side-nav-search img { + background-color: rgb(26, 82, 118); + } + .wy-side-nav-search .wy-dropdown > a, + .wy-side-nav-search > a { + color: rgb(215, 211, 206); + } + .wy-side-nav-search .wy-dropdown > a:hover, + .wy-side-nav-search > a:hover { + background-color: rgba(19, 21, 22, 0.1); + background-image: none; + } + .wy-side-nav-search .wy-dropdown > a img.logo, + .wy-side-nav-search > a img.logo { + background-color: transparent; + background-image: none; + } + .wy-side-nav-search > div.version { + color: rgba(216, 212, 207, 0.3); + } + .wy-nav .wy-menu-vertical header { + color: rgb(94, 169, 219); + } + .wy-nav .wy-menu-vertical a { + color: rgb(182, 176, 167); + } + .wy-nav .wy-menu-vertical a:hover { + background-color: rgb(26, 82, 118); + color: rgb(216, 212, 207); + } + .wy-body-for-nav { + background-color: rgb(21, 22, 23); + background-image: none; + } + .wy-nav-side { + color: rgb(172, 164, 154); + background-color: rgb(30, 33, 34); + background-image: none; + } + .wy-nav-top { + background-color: rgb(26, 82, 118); + background-image: none; + color: rgb(216, 212, 207); + } + .wy-nav-top a { + color: rgb(216, 212, 207); + } + .wy-nav-top img { + background-color: rgb(26, 82, 118); + } + .wy-nav-content-wrap { + background-color: rgb(21, 22, 23); + background-image: none; + } + .wy-body-mask { + background-color: rgba(0, 0, 0, 0.2); + background-image: none; + } + footer { + color: rgb(160, 151, 139); + } + .rst-content footer span.commit tt, + footer span.commit .rst-content tt, + footer span.commit code { + background-color: rgba(0, 0, 0, 0); + background-image: none; + border-color: currentcolor; + color: rgb(160, 151, 139); + } + #search-results .search li { + border-bottom-color: rgb(120, 112, 99); + } + #search-results .search li:first-child { + border-top-color: rgb(120, 112, 99); + } + #search-results .context { + color: rgb(160, 151, 139); + } + .wy-body-for-nav { + background-color: rgb(21, 22, 23); + background-image: none; + } + @media screen and (min-width: 1100px) { + .wy-nav-content-wrap { + background-color: rgba(0, 0, 0, 0.05); + background-image: none; + } + .wy-nav-content { + background-color: rgb(21, 22, 23); + background-image: none; + } + } + .rst-versions { + color: rgb(215, 211, 206); + background-color: rgb(18, 20, 20); + background-image: none; + } + .rst-versions a { + color: rgb(94, 169, 219); + text-decoration-color: currentcolor; + } + .rst-versions .rst-current-version { + background-color: rgb(23, 25, 26); + color: rgb(99, 220, 150); + } + .rst-content .code-block-caption .rst-versions .rst-current-version .headerlink, + .rst-content .rst-versions .rst-current-version .admonition-title, + .rst-content code.download .rst-versions .rst-current-version span:first-child, + .rst-content dl dt .rst-versions .rst-current-version .headerlink, + .rst-content h1 .rst-versions .rst-current-version .headerlink, + .rst-content h2 .rst-versions .rst-current-version .headerlink, + .rst-content h3 .rst-versions .rst-current-version .headerlink, + .rst-content h4 .rst-versions .rst-current-version .headerlink, + .rst-content h5 .rst-versions .rst-current-version .headerlink, + .rst-content h6 .rst-versions .rst-current-version .headerlink, + .rst-content p.caption .rst-versions .rst-current-version .headerlink, + .rst-content table > caption .rst-versions .rst-current-version .headerlink, + .rst-content tt.download .rst-versions .rst-current-version span:first-child, + .rst-versions .rst-current-version .fa, + .rst-versions .rst-current-version .icon, + .rst-versions .rst-current-version .rst-content .admonition-title, + .rst-versions .rst-current-version .rst-content .code-block-caption .headerlink, + .rst-versions .rst-current-version .rst-content code.download span:first-child, + .rst-versions .rst-current-version .rst-content dl dt .headerlink, + .rst-versions .rst-current-version .rst-content h1 .headerlink, + .rst-versions .rst-current-version .rst-content h2 .headerlink, + .rst-versions .rst-current-version .rst-content h3 .headerlink, + .rst-versions .rst-current-version .rst-content h4 .headerlink, + .rst-versions .rst-current-version .rst-content h5 .headerlink, + .rst-versions .rst-current-version .rst-content h6 .headerlink, + .rst-versions .rst-current-version .rst-content p.caption .headerlink, + .rst-versions .rst-current-version .rst-content table > caption .headerlink, + .rst-versions .rst-current-version .rst-content tt.download span:first-child, + .rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand, + .wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand { + color: rgb(215, 211, 206); + } + .rst-versions .rst-current-version.rst-out-of-date { + background-color: rgb(130, 26, 16); + color: rgb(216, 212, 207); + } + .rst-versions .rst-current-version.rst-active-old-version { + background-color: rgb(154, 125, 9); + color: rgb(216, 212, 207); + } + .rst-versions .rst-other-versions { + color: rgb(160, 151, 139); + } + .rst-versions .rst-other-versions hr { + border-color: rgb(104, 97, 86) currentcolor currentcolor; + } + .rst-versions .rst-other-versions dd a { + color: rgb(215, 211, 206); + } + .rst-versions.rst-badge { + border-color: currentcolor; + } + .rst-content abbr[title] { + text-decoration-color: currentcolor; + } + .rst-content.style-external-links a.reference.external::after { + color: rgb(182, 176, 167); + } + .rst-content div[class^="highlight"], + .rst-content pre.literal-block { + border-color: rgb(120, 112, 99); + } + .rst-content div[class^="highlight"] div[class^="highlight"], .rst-content pre.literal-block div[class^="highlight"] { + border-color: currentcolor; + } + .rst-content .linenodiv pre { + border-right-color: rgb(121, 112, 99); + } + .rst-content .admonition table { + border-color: rgba(84, 91, 95, 0.1); + } + .rst-content .admonition table td, + .rst-content .admonition table th { + background-color: transparent !important; + background-image: none !important; + border-color: rgba(84, 91, 95, 0.1) !important; + } + .rst-content .section ol.loweralpha, + .rst-content .section ol.loweralpha > li { + list-style-image: none; + } + .rst-content .section ol.upperalpha, + .rst-content .section ol.upperalpha > li { + list-style-image: none; + } + .rst-content .toc-backref { + color: rgb(188, 182, 173); + } + .rst-content .sidebar { + background-color: rgb(22, 29, 29); + background-image: none; + border-color: rgb(120, 112, 99); + } + .rst-content .sidebar .sidebar-title { + background-color: rgb(32, 35, 36); + background-image: none; + } + .rst-content .highlighted { + background-color: rgb(154, 125, 9); + background-image: none; + box-shadow: rgb(154, 125, 9) 0px 0px 0px 2px; + } + html.writer-html4 .rst-content table.docutils.citation, + html.writer-html4 .rst-content table.docutils.footnote { + background-color: rgba(0, 0, 0, 0); + background-image: none; + border-color: currentcolor; + } + html.writer-html4 .rst-content table.docutils.citation td, + html.writer-html4 .rst-content table.docutils.citation tr, + html.writer-html4 .rst-content table.docutils.footnote td, + html.writer-html4 .rst-content table.docutils.footnote tr { + border-color: currentcolor; + background-color: transparent !important; + } + .rst-content table.docutils.footnote, + html.writer-html4 .rst-content table.docutils.citation, + html.writer-html5 .rst-content dl.footnote { + color: rgb(160, 151, 139); + } + .rst-content table.docutils.footnote code, + .rst-content table.docutils.footnote tt, + html.writer-html4 .rst-content table.docutils.citation code, + html.writer-html4 .rst-content table.docutils.citation tt, + html.writer-html5 .rst-content dl.footnote code, + html.writer-html5 .rst-content dl.footnote tt { + color: rgb(178, 172, 162); + } + .rst-content table.docutils th { + border-color: rgb(120, 112, 99); + } + html.writer-html5 .rst-content table.docutils th { + border-color: rgb(120, 112, 99); + } + .rst-content table.field-list, + .rst-content table.field-list td { + border-color: currentcolor; + } + .rst-content code, + .rst-content tt { + color: rgb(216, 212, 207); + } + .rst-content code.literal, + .rst-content tt.literal { + color: rgb(227, 134, 124); + } + .rst-content code.xref, + .rst-content tt.xref, + a .rst-content code, + a .rst-content tt { + color: rgb(188, 182, 173); + } + .rst-content a code, + .rst-content a tt { + color: rgb(94, 169, 219); + } + html.writer-html4 .rst-content dl:not(.docutils) > dt, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) > dt { + background-color: rgb(26, 28, 29); + background-image: none; + color: rgb(94, 169, 219); + border-top-color: rgb(37, 119, 171); + } + html.writer-html4 .rst-content dl:not(.docutils) > dt::before, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) > dt::before { + color: rgb(111, 179, 223); + } + html.writer-html4 .rst-content dl:not(.docutils) > dt .headerlink, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) > dt .headerlink { + color: rgb(188, 182, 173); + } + html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list) > dt, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list) > dt { + border-color: currentcolor currentcolor currentcolor rgb(118, 110, 97); + background-color: rgb(26, 28, 29); + background-image: none; + color: rgb(178, 172, 162); + } + html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list) > dt .headerlink, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list) > dt .headerlink { + color: rgb(188, 182, 173); + } + html.writer-html4 .rst-content dl:not(.docutils) code.descclassname, + html.writer-html4 .rst-content dl:not(.docutils) code.descname, + html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname, + html.writer-html4 .rst-content dl:not(.docutils) tt.descname, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname { + background-color: transparent; + border-color: currentcolor; + } + html.writer-html4 .rst-content dl:not(.docutils) .optional, + html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional { + color: rgb(216, 212, 207); + } + .rst-content .viewcode-back, + .rst-content .viewcode-link { + color: rgb(99, 220, 150); + } + .rst-content code.download, + .rst-content tt.download { + background-color: inherit; + background-image: inherit; + color: inherit; + border-color: inherit; + } + .rst-content .guilabel { + border-color: rgb(38, 119, 172); + background-color: rgb(26, 28, 29); background-image: none; + } + span[id*="MathJax-Span"] { + color: rgb(188, 182, 173); + } + td.linenos .normal { + color: inherit; + background-color: transparent; + } + span.linenos { + color: inherit; + background-color: transparent; + } + td.linenos .special { + color: rgb(216, 212, 207); + background-color: rgb(71, 71, 0); + } + span.linenos.special { + color: rgb(216, 212, 207); + background-color: rgb(71, 71, 0); + } + .highlight .hll { + background-color: rgb(66, 66, 0); + } + .highlight { + background-color: rgb(32, 34, 36); + background-image: none; + } + .highlight .c { + color: rgb(124, 182, 197); + } + .highlight .err { + border-color: rgb(201, 0, 0); + } + .highlight .k { + color: rgb(114, 255, 154); + } + .highlight .o { + color: rgb(171, 164, 153); + } + .highlight .ch { + color: rgb(124, 182, 197); + } + .highlight .cm { + color: rgb(124, 182, 197); + } + .highlight .cp { + color: rgb(114, 255, 154); + } + .highlight .cpf { + color: rgb(124, 182, 197); + } + .highlight .c1 { + color: rgb(124, 182, 197); + } + .highlight .cs { + color: rgb(124, 182, 197); + background-color: rgb(48, 0, 0); + } + .highlight .gd { + color: rgb(255, 90, 90); + } + .highlight .gr { + color: rgb(255, 44, 44); + } + .highlight .gh { + color: rgb(114, 185, 255); + } + .highlight .gi { + color: rgb(90, 255, 90); + } + .highlight .go { + color: rgb(193, 188, 180); + } + .highlight .gp { + color: rgb(246, 151, 75); + } + .highlight .gu { + color: rgb(255, 105, 255); + } + .highlight .gt { + color: rgb(75, 173, 255); + } + .highlight .kc { + color: rgb(114, 255, 154); + } + .highlight .kd { + color: rgb(114, 255, 154); + } + .highlight .kn { + color: rgb(114, 255, 154); + } + .highlight .kp { + color: rgb(114, 255, 154); + } + .highlight .kr { + color: rgb(114, 255, 154); + } + .highlight .kt { + color: rgb(255, 133, 98); + } + .highlight .m { + color: rgb(123, 222, 173); + } + .highlight .s { + color: rgb(126, 170, 203); + } + .highlight .na { + color: rgb(126, 170, 203); + } + .highlight .nb { + color: rgb(114, 255, 154); + } + .highlight .nc { + color: rgb(86, 196, 242); + } + .highlight .no { + color: rgb(108, 180, 216); + } + .highlight .nd { + color: rgb(178, 172, 162); + } + .highlight .ni { + color: rgb(220, 111, 85); + } + .highlight .ne { + color: rgb(114, 255, 154); + } + .highlight .nf { + color: rgb(120, 189, 248); + } + .highlight .nl { + color: rgb(121, 194, 255); + } + .highlight .nn { + color: rgb(86, 196, 242); + } + .highlight .nt { + color: rgb(125, 192, 248); + } + .highlight .nv { + color: rgb(192, 108, 216); + } + .highlight .ow { + color: rgb(114, 255, 154); + } + .highlight .w { + color: rgb(186, 180, 171); + } + .highlight .mb { + color: rgb(123, 222, 173); + } + .highlight .mf { + color: rgb(123, 222, 173); + } + .highlight .mh { + color: rgb(123, 222, 173); + } + .highlight .mi { + color: rgb(123, 222, 173); + } + .highlight .mo { + color: rgb(123, 222, 173); + } + .highlight .sa { + color: rgb(126, 170, 203); + } + .highlight .sb { + color: rgb(126, 170, 203); + } + .highlight .sc { + color: rgb(126, 170, 203); + } + .highlight .dl { + color: rgb(126, 170, 203); + } + .highlight .sd { + color: rgb(126, 170, 203); + } + .highlight .s2 { + color: rgb(126, 170, 203); + } + .highlight .se { + color: rgb(126, 170, 203); + } + .highlight .sh { + color: rgb(126, 170, 203); + } + .highlight .si { + color: rgb(120, 172, 210); + } + .highlight .sx { + color: rgb(246, 151, 75); + } + .highlight .sr { + color: rgb(129, 182, 223); + } + .highlight .s1 { + color: rgb(126, 170, 203); + } + .highlight .ss { + color: rgb(186, 229, 123); + } + .highlight .bp { + color: rgb(114, 255, 154); + } + .highlight .fm { + color: rgb(120, 189, 248); + } + .highlight .vc { + color: rgb(192, 108, 216); + } + .highlight .vg { + color: rgb(192, 108, 216); + } + .highlight .vi { + color: rgb(192, 108, 216); + } + .highlight .vm { + color: rgb(192, 108, 216); + } + .highlight .il { + color: rgb(123, 222, 173); + } + .rst-other-versions a { + border-color: currentcolor; + } + .ethical-sidebar .ethical-image-link, + .ethical-footer .ethical-image-link { + border-color: currentcolor; + } + .ethical-sidebar, + .ethical-footer { + background-color: rgb(27, 29, 30); + border-color: rgb(118, 110, 97); + color: rgb(211, 208, 202); + } + .ethical-sidebar ul { + list-style-image: none; + } + .ethical-sidebar ul li { + background-color: rgb(4, 62, 97); + color: rgb(216, 212, 207); + } + .ethical-sidebar a, + .ethical-sidebar a:visited, + .ethical-sidebar a:hover, + .ethical-sidebar a:active, + .ethical-footer a, + .ethical-footer a:visited, + .ethical-footer a:hover, + .ethical-footer a:active { + color: rgb(211, 208, 202); + text-decoration-color: currentcolor !important; + border-bottom-color: currentcolor !important; + } + .ethical-callout a { + color: rgb(166, 159, 147) !important; + text-decoration-color: currentcolor !important; + } + .ethical-fixedfooter { + background-color: rgb(27, 29, 30); + border-top-color: rgb(117, 109, 96); + color: rgb(188, 182, 173); + } + .ethical-fixedfooter .ethical-text::before { + background-color: rgb(49, 112, 51); + color: rgb(216, 212, 207); + } + .ethical-fixedfooter .ethical-callout { + color: rgb(171, 164, 153); + } + .ethical-fixedfooter a, + .ethical-fixedfooter a:hover, + .ethical-fixedfooter a:active, + .ethical-fixedfooter a:visited { + color: rgb(188, 182, 173); + text-decoration-color: currentcolor; + } + .ethical-rtd .ethical-sidebar { + color: rgb(182, 176, 167); + } + .ethical-alabaster a.ethical-image-link { + border-color: currentcolor !important; + } + .ethical-dark-theme .ethical-sidebar { + background-color: rgb(46, 50, 52); + border-color: rgb(114, 106, 93); + color: rgb(189, 183, 174) !important; + } + .ethical-dark-theme a, + .ethical-dark-theme a:visited { + color: rgb(205, 200, 194) !important; + border-bottom-color: currentcolor !important; + } + .ethical-dark-theme .ethical-callout a { + color: rgb(182, 176, 167) !important; + } + .keep-us-sustainable { + border-color: rgb(104, 158, 45); + } + .keep-us-sustainable a, + .keep-us-sustainable a:hover, + .keep-us-sustainable a:visited { + text-decoration-color: currentcolor; + } + .wy-nav-side .keep-us-sustainable { + color: rgb(182, 176, 167); + } + .wy-nav-side .keep-us-sustainable a { + color: rgb(209, 205, 199); + } + [data-ea-publisher].loaded a, + [data-ea-type].loaded a { + text-decoration-color: currentcolor; + } + [data-ea-publisher].loaded .ea-content, + [data-ea-type].loaded .ea-content { + background-color: rgba(0, 0, 0, 0.03); + background-image: none; + color: rgb(181, 174, 164); + } + [data-ea-publisher].loaded .ea-content a:link, + [data-ea-type].loaded .ea-content a:link { + color: rgb(181, 174, 164); + } + [data-ea-publisher].loaded .ea-content a:visited, + [data-ea-type].loaded .ea-content a:visited { + color: rgb(181, 174, 164); + } + [data-ea-publisher].loaded .ea-content a:hover, + [data-ea-type].loaded .ea-content a:hover { + color: rgb(192, 186, 178); + } + [data-ea-publisher].loaded .ea-content a:active, + [data-ea-type].loaded .ea-content a:active { + color: rgb(192, 186, 178); + } + [data-ea-publisher].loaded .ea-content a strong, + [data-ea-publisher].loaded .ea-content a b, + [data-ea-type].loaded .ea-content a strong, + [data-ea-type].loaded .ea-content a b { + color: rgb(64, 180, 248); + } + [data-ea-publisher].loaded .ea-callout a:link, + [data-ea-type].loaded .ea-callout a:link { + color: rgb(169, 162, 151); + } + [data-ea-publisher].loaded .ea-callout a:visited, + [data-ea-type].loaded .ea-callout a:visited { + color: rgb(169, 162, 151); + } + [data-ea-publisher].loaded .ea-callout a:hover, + [data-ea-type].loaded .ea-callout a:hover { + color: rgb(181, 174, 164); + } + [data-ea-publisher].loaded .ea-callout a:active, + [data-ea-type].loaded .ea-callout a:active { + color: rgb(181, 174, 164); + } + [data-ea-publisher].loaded .ea-callout a strong, + [data-ea-publisher].loaded .ea-callout a b, + [data-ea-type].loaded .ea-callout a strong, + [data-ea-type].loaded .ea-callout a b { + color: rgb(64, 180, 248); + } + [data-ea-publisher].loaded.dark .ea-content, + [data-ea-type].loaded.dark .ea-content { + background-color: rgba(19, 21, 22, 0.05); + background-image: none; + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.dark .ea-content a:link, + [data-ea-type].loaded.dark .ea-content a:link { + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.dark .ea-content a:visited, + [data-ea-type].loaded.dark .ea-content a:visited { + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.dark .ea-content a:hover, + [data-ea-type].loaded.dark .ea-content a:hover { + color: rgb(212, 208, 202); + } + [data-ea-publisher].loaded.dark .ea-content a:active, + [data-ea-type].loaded.dark .ea-content a:active { + color: rgb(212, 208, 202); + } + [data-ea-publisher].loaded.dark .ea-content a strong, + [data-ea-publisher].loaded.dark .ea-content a b, + [data-ea-type].loaded.dark .ea-content a strong, + [data-ea-type].loaded.dark .ea-content a b { + color: rgb(85, 188, 249); + } + [data-ea-publisher].loaded.dark .ea-callout a:link, + [data-ea-type].loaded.dark .ea-callout a:link { + color: rgb(189, 184, 175); + } + [data-ea-publisher].loaded.dark .ea-callout a:visited, + [data-ea-type].loaded.dark .ea-callout a:visited { + color: rgb(189, 184, 175); + } + [data-ea-publisher].loaded.dark .ea-callout a:hover, + [data-ea-type].loaded.dark .ea-callout a:hover { + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.dark .ea-callout a:active, + [data-ea-type].loaded.dark .ea-callout a:active { + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.dark .ea-callout a strong, + [data-ea-publisher].loaded.dark .ea-callout a b, + [data-ea-type].loaded.dark .ea-callout a strong, + [data-ea-type].loaded.dark .ea-callout a b { + color: rgb(85, 188, 249); + } + @media (prefers-color-scheme: dark) { + [data-ea-publisher].loaded.adaptive .ea-content, + [data-ea-type].loaded.adaptive .ea-content { + background-color: rgba(19, 21, 22, 0.05); + background-image: none; + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.adaptive .ea-content a:link, + [data-ea-type].loaded.adaptive .ea-content a:link { + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.adaptive .ea-content a:visited, + [data-ea-type].loaded.adaptive .ea-content a:visited { + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.adaptive .ea-content a:hover, + [data-ea-type].loaded.adaptive .ea-content a:hover { + color: rgb(212, 208, 202); + } + [data-ea-publisher].loaded.adaptive .ea-content a:active, + [data-ea-type].loaded.adaptive .ea-content a:active { + color: rgb(212, 208, 202); + } + [data-ea-publisher].loaded.adaptive .ea-content a strong, + [data-ea-publisher].loaded.adaptive .ea-content a b, + [data-ea-type].loaded.adaptive .ea-content a strong, + [data-ea-type].loaded.adaptive .ea-content a b { + color: rgb(85, 188, 249); + } + [data-ea-publisher].loaded.adaptive .ea-callout a:link, + [data-ea-type].loaded.adaptive .ea-callout a:link { + color: rgb(189, 184, 175); + } + [data-ea-publisher].loaded.adaptive .ea-callout a:visited, + [data-ea-type].loaded.adaptive .ea-callout a:visited { + color: rgb(189, 184, 175); + } + [data-ea-publisher].loaded.adaptive .ea-callout a:hover, + [data-ea-type].loaded.adaptive .ea-callout a:hover { + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.adaptive .ea-callout a:active, + [data-ea-type].loaded.adaptive .ea-callout a:active { + color: rgb(200, 196, 189); + } + [data-ea-publisher].loaded.adaptive .ea-callout a strong, + [data-ea-publisher].loaded.adaptive .ea-callout a b, + [data-ea-type].loaded.adaptive .ea-callout a strong, + [data-ea-type].loaded.adaptive .ea-callout a b { + color: rgb(85, 188, 249); + } + } + [data-ea-publisher].loaded .ea-content, + [data-ea-type].loaded .ea-content { + border-color: currentcolor; + box-shadow: rgba(0, 0, 0, 0.15) 0px 2px 3px; + } + [data-ea-publisher].loaded.raised .ea-content, + [data-ea-type].loaded.raised .ea-content { + border-color: currentcolor; + box-shadow: rgba(0, 0, 0, 0.15) 0px 2px 3px; + } + [data-ea-publisher].loaded.bordered .ea-content, + [data-ea-type].loaded.bordered .ea-content { + border-color: rgba(84, 91, 95, 0.04); + box-shadow: none; + } + [data-ea-publisher].loaded.bordered.dark .ea-content, + [data-ea-type].loaded.bordered.dark .ea-content { + border-color: rgba(123, 114, 101, 0.07); + } + @media (prefers-color-scheme: dark) { + [data-ea-publisher].loaded.bordered.adaptive .ea-content, + [data-ea-type].loaded.bordered.adaptive .ea-content { + border-color: rgba(123, 114, 101, 0.07); + } + } + [data-ea-publisher].loaded.flat .ea-content, + [data-ea-type].loaded.flat .ea-content { + border-color: currentcolor; + box-shadow: none; + } + .vimvixen-hint { + background-color: rgb(98, 66, 0) !important; + border-color: rgb(170, 138, 15) !important; + color: rgb(237, 221, 175) !important; + } + #edge-translate-panel-body { + color: var(--darkreader-text--darkreader-neutral-text) !important; + } + } + + /* Override Style */ + .vimvixen-hint { + background-color: #7b5300 !important; + border-color: #d8b013 !important; + color: #f3e8c8 !important; + } + ::placeholder { + opacity: 0.5 !important; + } + a[href="https://coinmarketcap.com/"] > svg[width="94"][height="16"] > path { + fill: var(--darkreader-neutral-text) !important; + } + #edge-translate-panel-body { + color: var(--darkreader-neutral-text) !important; + } + +} \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index cb75bfece..f272f8e17 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -51,7 +51,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Python Telegram Bot' +project = u'python-telegram-bot' copyright = u'2015-2021, Leandro Toledo' author = u'Leandro Toledo' @@ -118,7 +118,9 @@ html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + 'style_external_links': True, +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] @@ -205,7 +207,7 @@ html_static_path = ['_static'] #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'PythonTelegramBotdoc' +htmlhelp_basename = 'python-telegram-bot-doc' # -- Options for LaTeX output --------------------------------------------- @@ -230,7 +232,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'PythonTelegramBot.tex', u'Python Telegram Bot Documentation', + (master_doc, 'python-telegram-bot.tex', u'python-telegram-bot Documentation', author, 'manual'), ] @@ -260,7 +262,7 @@ latex_logo = 'ptb-logo_1024.png' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'pythontelegrambot', u'Python Telegram Bot Documentation', + (master_doc, 'python-telegram-bot', u'python-telegram-bot Documentation', [author], 1) ] @@ -274,8 +276,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'PythonTelegramBot', u'Python Telegram Bot Documentation', - author, 'PythonTelegramBot', "We have made you a wrapper you can't refuse", + (master_doc, 'python-telegram-bot', u'python-telegram-bot Documentation', + author, 'python-telegram-bot', "We have made you a wrapper you can't refuse", 'Miscellaneous'), ] @@ -303,4 +305,5 @@ def autodoc_skip_member(app, what, name, obj, skip, options): def setup(app): + app.add_css_file("dark.css") app.connect('autodoc-skip-member', autodoc_skip_member) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ab23f8ef..4b8f910b2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,14 +15,17 @@ On our wiki you will also find guides like how to use handlers, webhooks, emoji, Examples ======== -A great way to learn is by looking at examples. Ours can be found at our `github in the examples folder `_. +A great way to learn is by looking at examples. Ours can be found in our `examples folder on Github `_. Reference ========= Below you can find a reference of all the classes and methods in python-telegram-bot. -Apart from the `telegram.ext` package the objects should reflect the types defined in the `official telegram bot api documentation `_. +Apart from the `telegram.ext` package the objects should reflect the types defined in the `official Telegram Bot API documentation `_. + +.. toctree:: + telegram.ext .. toctree:: telegram diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst index 36828083f..65d2630e6 100644 --- a/docs/source/telegram.animation.rst +++ b/docs/source/telegram.animation.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/animation.py + telegram.Animation ================== diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst index 5706f68ff..9df1943ff 100644 --- a/docs/source/telegram.audio.rst +++ b/docs/source/telegram.audio.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/audio.py + telegram.Audio ============== diff --git a/docs/source/telegram.bot.rst b/docs/source/telegram.bot.rst index 6b620b5fb..9869dedc1 100644 --- a/docs/source/telegram.bot.rst +++ b/docs/source/telegram.bot.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/bot.py + telegram.Bot ============ diff --git a/docs/source/telegram.botcommand.rst b/docs/source/telegram.botcommand.rst index 9ceb402c5..26dece6ad 100644 --- a/docs/source/telegram.botcommand.rst +++ b/docs/source/telegram.botcommand.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommand.py + telegram.BotCommand =================== diff --git a/docs/source/telegram.callbackgame.rst b/docs/source/telegram.callbackgame.rst index 6fa11ded8..e2facc41e 100644 --- a/docs/source/telegram.callbackgame.rst +++ b/docs/source/telegram.callbackgame.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/callbackgame.py + telegram.Callbackgame ===================== diff --git a/docs/source/telegram.callbackquery.rst b/docs/source/telegram.callbackquery.rst index 297189aaf..b628b0236 100644 --- a/docs/source/telegram.callbackquery.rst +++ b/docs/source/telegram.callbackquery.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackquery.py + telegram.CallbackQuery ====================== diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst index cd04bb87b..7347e5d13 100644 --- a/docs/source/telegram.chat.rst +++ b/docs/source/telegram.chat.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chat.py + telegram.Chat ============= diff --git a/docs/source/telegram.chataction.rst b/docs/source/telegram.chataction.rst index adf674491..f0ac01110 100644 --- a/docs/source/telegram.chataction.rst +++ b/docs/source/telegram.chataction.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chataction.py + telegram.ChatAction =================== diff --git a/docs/source/telegram.chatinvitelink.rst b/docs/source/telegram.chatinvitelink.rst index ca24e5340..e85f97fb6 100644 --- a/docs/source/telegram.chatinvitelink.rst +++ b/docs/source/telegram.chatinvitelink.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatinvitelink.py + telegram.ChatInviteLink ======================= diff --git a/docs/source/telegram.chatlocation.rst b/docs/source/telegram.chatlocation.rst index 8994d138e..dd0c2f006 100644 --- a/docs/source/telegram.chatlocation.rst +++ b/docs/source/telegram.chatlocation.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatlocation.py + telegram.ChatLocation ===================== diff --git a/docs/source/telegram.chatmember.rst b/docs/source/telegram.chatmember.rst index 7bba9e448..2aa4a58f2 100644 --- a/docs/source/telegram.chatmember.rst +++ b/docs/source/telegram.chatmember.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py + telegram.ChatMember =================== diff --git a/docs/source/telegram.chatmemberupdated.rst b/docs/source/telegram.chatmemberupdated.rst index d6feecc44..c5c141260 100644 --- a/docs/source/telegram.chatmemberupdated.rst +++ b/docs/source/telegram.chatmemberupdated.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmemberupdated.py + telegram.ChatMemberUpdated ========================== diff --git a/docs/source/telegram.chatpermissions.rst b/docs/source/telegram.chatpermissions.rst index 7cefdbc23..bb180946d 100644 --- a/docs/source/telegram.chatpermissions.rst +++ b/docs/source/telegram.chatpermissions.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatpermissions.py + telegram.ChatPermissions ======================== diff --git a/docs/source/telegram.chatphoto.rst b/docs/source/telegram.chatphoto.rst index 4ab6ae0a2..22a9aaad3 100644 --- a/docs/source/telegram.chatphoto.rst +++ b/docs/source/telegram.chatphoto.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/chatphoto.py + telegram.ChatPhoto ================== diff --git a/docs/source/telegram.choseninlineresult.rst b/docs/source/telegram.choseninlineresult.rst index d60547d4b..cb997a913 100644 --- a/docs/source/telegram.choseninlineresult.rst +++ b/docs/source/telegram.choseninlineresult.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/choseninlineresult.py + telegram.ChosenInlineResult =========================== diff --git a/docs/source/telegram.constants.rst b/docs/source/telegram.constants.rst index 124951465..a223a220b 100644 --- a/docs/source/telegram.constants.rst +++ b/docs/source/telegram.constants.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/constants.py + telegram.constants Module ========================= diff --git a/docs/source/telegram.contact.rst b/docs/source/telegram.contact.rst index f38079be9..345c00584 100644 --- a/docs/source/telegram.contact.rst +++ b/docs/source/telegram.contact.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/contact.py + telegram.Contact ================ diff --git a/docs/source/telegram.credentials.rst b/docs/source/telegram.credentials.rst index 6a3fe39e1..59f4f36e4 100644 --- a/docs/source/telegram.credentials.rst +++ b/docs/source/telegram.credentials.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py + telegram.Credentials ==================== diff --git a/docs/source/telegram.datacredentials.rst b/docs/source/telegram.datacredentials.rst index b0916762e..51d85455f 100644 --- a/docs/source/telegram.datacredentials.rst +++ b/docs/source/telegram.datacredentials.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py + telegram.DataCredentials ======================== diff --git a/docs/source/telegram.dice.rst b/docs/source/telegram.dice.rst index 6e80f6d48..29dedd5b5 100644 --- a/docs/source/telegram.dice.rst +++ b/docs/source/telegram.dice.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/dice.py + telegram.Dice ============= diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst index f47c674c6..698247732 100644 --- a/docs/source/telegram.document.rst +++ b/docs/source/telegram.document.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/document.py + telegram.Document ================= diff --git a/docs/source/telegram.encryptedcredentials.rst b/docs/source/telegram.encryptedcredentials.rst index d42851436..096efbcc0 100644 --- a/docs/source/telegram.encryptedcredentials.rst +++ b/docs/source/telegram.encryptedcredentials.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py + telegram.EncryptedCredentials ============================= diff --git a/docs/source/telegram.encryptedpassportelement.rst b/docs/source/telegram.encryptedpassportelement.rst index f22963601..5a9693be3 100644 --- a/docs/source/telegram.encryptedpassportelement.rst +++ b/docs/source/telegram.encryptedpassportelement.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/encryptedpassportelement.py + telegram.EncryptedPassportElement ================================= diff --git a/docs/source/telegram.error.rst b/docs/source/telegram.error.rst index a76bf0d1f..2d95e7aaf 100644 --- a/docs/source/telegram.error.rst +++ b/docs/source/telegram.error.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/error.py + telegram.error module ===================== diff --git a/docs/source/telegram.ext.basepersistence.rst b/docs/source/telegram.ext.basepersistence.rst index 013c052d8..178d95a80 100644 --- a/docs/source/telegram.ext.basepersistence.rst +++ b/docs/source/telegram.ext.basepersistence.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/basepersistence.py + telegram.ext.BasePersistence ============================ diff --git a/docs/source/telegram.ext.callbackcontext.rst b/docs/source/telegram.ext.callbackcontext.rst index 364879318..bd5ff3706 100644 --- a/docs/source/telegram.ext.callbackcontext.rst +++ b/docs/source/telegram.ext.callbackcontext.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackcontext.py + telegram.ext.CallbackContext ============================ diff --git a/docs/source/telegram.ext.callbackqueryhandler.rst b/docs/source/telegram.ext.callbackqueryhandler.rst index 4e876e413..8f72eecb2 100644 --- a/docs/source/telegram.ext.callbackqueryhandler.rst +++ b/docs/source/telegram.ext.callbackqueryhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackqueryhandler.py + telegram.ext.CallbackQueryHandler ================================= diff --git a/docs/source/telegram.ext.chatmemberhandler.rst b/docs/source/telegram.ext.chatmemberhandler.rst index 59675b954..976014959 100644 --- a/docs/source/telegram.ext.chatmemberhandler.rst +++ b/docs/source/telegram.ext.chatmemberhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/chatmemberhandler.py + telegram.ext.ChatMemberHandler ============================== diff --git a/docs/source/telegram.ext.choseninlineresulthandler.rst b/docs/source/telegram.ext.choseninlineresulthandler.rst index e415c2d7e..8ada326a6 100644 --- a/docs/source/telegram.ext.choseninlineresulthandler.rst +++ b/docs/source/telegram.ext.choseninlineresulthandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/choseninlineresulthandler.py + telegram.ext.ChosenInlineResultHandler ====================================== diff --git a/docs/source/telegram.ext.commandhandler.rst b/docs/source/telegram.ext.commandhandler.rst index a892d3ca8..4b8d869e9 100644 --- a/docs/source/telegram.ext.commandhandler.rst +++ b/docs/source/telegram.ext.commandhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/commandhandler.py + telegram.ext.CommandHandler =========================== diff --git a/docs/source/telegram.ext.conversationhandler.rst b/docs/source/telegram.ext.conversationhandler.rst index aa4bac815..2f5007d15 100644 --- a/docs/source/telegram.ext.conversationhandler.rst +++ b/docs/source/telegram.ext.conversationhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/conversationhandler.py + telegram.ext.ConversationHandler ================================ diff --git a/docs/source/telegram.ext.defaults.rst b/docs/source/telegram.ext.defaults.rst index d08a6ed5c..66a338704 100644 --- a/docs/source/telegram.ext.defaults.rst +++ b/docs/source/telegram.ext.defaults.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/defaults.py + telegram.ext.Defaults ===================== diff --git a/docs/source/telegram.ext.delayqueue.rst b/docs/source/telegram.ext.delayqueue.rst index ee79b8494..cf64f2bc7 100644 --- a/docs/source/telegram.ext.delayqueue.rst +++ b/docs/source/telegram.ext.delayqueue.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/messagequeue.py + telegram.ext.DelayQueue ======================= diff --git a/docs/source/telegram.ext.dictpersistence.rst b/docs/source/telegram.ext.dictpersistence.rst index 08b78de37..95ea3ef3f 100644 --- a/docs/source/telegram.ext.dictpersistence.rst +++ b/docs/source/telegram.ext.dictpersistence.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/dictpersistence.py + telegram.ext.DictPersistence ============================ diff --git a/docs/source/telegram.ext.dispatcher.rst b/docs/source/telegram.ext.dispatcher.rst index 57259e7cf..268be2ac0 100644 --- a/docs/source/telegram.ext.dispatcher.rst +++ b/docs/source/telegram.ext.dispatcher.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/dispatcher.py + telegram.ext.Dispatcher ======================= diff --git a/docs/source/telegram.ext.dispatcherhandlerstop.rst b/docs/source/telegram.ext.dispatcherhandlerstop.rst index e115eb8b3..6894a840f 100644 --- a/docs/source/telegram.ext.dispatcherhandlerstop.rst +++ b/docs/source/telegram.ext.dispatcherhandlerstop.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/dispatcher.py + telegram.ext.DispatcherHandlerStop ================================== diff --git a/docs/source/telegram.ext.filters.rst b/docs/source/telegram.ext.filters.rst index 9e9125785..c4e12c714 100644 --- a/docs/source/telegram.ext.filters.rst +++ b/docs/source/telegram.ext.filters.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/filters.py + telegram.ext.filters Module =========================== diff --git a/docs/source/telegram.ext.handler.rst b/docs/source/telegram.ext.handler.rst index 4576e3b8f..7b8224573 100644 --- a/docs/source/telegram.ext.handler.rst +++ b/docs/source/telegram.ext.handler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/handler.py + telegram.ext.Handler ==================== diff --git a/docs/source/telegram.ext.inlinequeryhandler.rst b/docs/source/telegram.ext.inlinequeryhandler.rst index 5b249c9fa..ea2ddeaf7 100644 --- a/docs/source/telegram.ext.inlinequeryhandler.rst +++ b/docs/source/telegram.ext.inlinequeryhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/inlinequeryhandler.py + telegram.ext.InlineQueryHandler =============================== diff --git a/docs/source/telegram.ext.job.rst b/docs/source/telegram.ext.job.rst index dc969f72b..50bfd9e7b 100644 --- a/docs/source/telegram.ext.job.rst +++ b/docs/source/telegram.ext.job.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/jobqueue.py + telegram.ext.Job ===================== diff --git a/docs/source/telegram.ext.jobqueue.rst b/docs/source/telegram.ext.jobqueue.rst index 080d64226..ec5f98398 100644 --- a/docs/source/telegram.ext.jobqueue.rst +++ b/docs/source/telegram.ext.jobqueue.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/jobqueue.py + telegram.ext.JobQueue ===================== diff --git a/docs/source/telegram.ext.messagehandler.rst b/docs/source/telegram.ext.messagehandler.rst index 2d1ca39bf..262c1aa06 100644 --- a/docs/source/telegram.ext.messagehandler.rst +++ b/docs/source/telegram.ext.messagehandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/messagehandler.py + telegram.ext.MessageHandler =========================== diff --git a/docs/source/telegram.ext.messagequeue.rst b/docs/source/telegram.ext.messagequeue.rst index 98bcb6e63..0b824f1e9 100644 --- a/docs/source/telegram.ext.messagequeue.rst +++ b/docs/source/telegram.ext.messagequeue.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/messagequeue.py + telegram.ext.MessageQueue ========================= diff --git a/docs/source/telegram.ext.picklepersistence.rst b/docs/source/telegram.ext.picklepersistence.rst index f8691b181..fc1dcd7a5 100644 --- a/docs/source/telegram.ext.picklepersistence.rst +++ b/docs/source/telegram.ext.picklepersistence.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/picklepersistence.py + telegram.ext.PicklePersistence ============================== diff --git a/docs/source/telegram.ext.pollanswerhandler.rst b/docs/source/telegram.ext.pollanswerhandler.rst index 5113f135e..fa049fa9f 100644 --- a/docs/source/telegram.ext.pollanswerhandler.rst +++ b/docs/source/telegram.ext.pollanswerhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/pollanswerhandler.py + telegram.ext.PollAnswerHandler ============================== diff --git a/docs/source/telegram.ext.pollhandler.rst b/docs/source/telegram.ext.pollhandler.rst index da30d879f..14a9d003a 100644 --- a/docs/source/telegram.ext.pollhandler.rst +++ b/docs/source/telegram.ext.pollhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/pollhandler.py + telegram.ext.PollHandler ======================== diff --git a/docs/source/telegram.ext.precheckoutqueryhandler.rst b/docs/source/telegram.ext.precheckoutqueryhandler.rst index 28fe9d49a..c7138853d 100644 --- a/docs/source/telegram.ext.precheckoutqueryhandler.rst +++ b/docs/source/telegram.ext.precheckoutqueryhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/precheckoutqueryhandler.py + telegram.ext.PreCheckoutQueryHandler ==================================== diff --git a/docs/source/telegram.ext.prefixhandler.rst b/docs/source/telegram.ext.prefixhandler.rst index 18fb2be14..d61e35892 100644 --- a/docs/source/telegram.ext.prefixhandler.rst +++ b/docs/source/telegram.ext.prefixhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/commandhandler.py + telegram.ext.PrefixHandler =========================== diff --git a/docs/source/telegram.ext.regexhandler.rst b/docs/source/telegram.ext.regexhandler.rst index be8d42586..efe40ef29 100644 --- a/docs/source/telegram.ext.regexhandler.rst +++ b/docs/source/telegram.ext.regexhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/regexhandler.py + telegram.ext.RegexHandler ========================= diff --git a/docs/source/telegram.ext.shippingqueryhandler.rst b/docs/source/telegram.ext.shippingqueryhandler.rst index 7da2992b9..013ef57b8 100644 --- a/docs/source/telegram.ext.shippingqueryhandler.rst +++ b/docs/source/telegram.ext.shippingqueryhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/shippingqueryhandler.py + telegram.ext.ShippingQueryHandler ================================= diff --git a/docs/source/telegram.ext.stringcommandhandler.rst b/docs/source/telegram.ext.stringcommandhandler.rst index 57ed1710e..5fe5dc82b 100644 --- a/docs/source/telegram.ext.stringcommandhandler.rst +++ b/docs/source/telegram.ext.stringcommandhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/stringcommandhandler.py + telegram.ext.StringCommandHandler ================================= diff --git a/docs/source/telegram.ext.stringregexhandler.rst b/docs/source/telegram.ext.stringregexhandler.rst index 621d9b732..127239db9 100644 --- a/docs/source/telegram.ext.stringregexhandler.rst +++ b/docs/source/telegram.ext.stringregexhandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/stringregexhandler.py + telegram.ext.StringRegexHandler =============================== diff --git a/docs/source/telegram.ext.typehandler.rst b/docs/source/telegram.ext.typehandler.rst index 05ebd4ee3..49dfbbf11 100644 --- a/docs/source/telegram.ext.typehandler.rst +++ b/docs/source/telegram.ext.typehandler.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/typehandler.py + telegram.ext.TypeHandler ======================== diff --git a/docs/source/telegram.ext.updater.rst b/docs/source/telegram.ext.updater.rst index 2a52132d7..dcd8ce4c0 100644 --- a/docs/source/telegram.ext.updater.rst +++ b/docs/source/telegram.ext.updater.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/updater.py + telegram.ext.Updater ==================== diff --git a/docs/source/telegram.ext.utils.promise.rst b/docs/source/telegram.ext.utils.promise.rst index c857c3872..aee183d01 100644 --- a/docs/source/telegram.ext.utils.promise.rst +++ b/docs/source/telegram.ext.utils.promise.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/utils/promise.py + telegram.ext.utils.promise.Promise ================================== diff --git a/docs/source/telegram.file.rst b/docs/source/telegram.file.rst index f04d547ab..8db85d86d 100644 --- a/docs/source/telegram.file.rst +++ b/docs/source/telegram.file.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/file.py + telegram.File ============= diff --git a/docs/source/telegram.filecredentials.rst b/docs/source/telegram.filecredentials.rst index 600661e50..bc2d88e77 100644 --- a/docs/source/telegram.filecredentials.rst +++ b/docs/source/telegram.filecredentials.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py + telegram.FileCredentials ======================== diff --git a/docs/source/telegram.forcereply.rst b/docs/source/telegram.forcereply.rst index 75bfc166a..2ee8edce8 100644 --- a/docs/source/telegram.forcereply.rst +++ b/docs/source/telegram.forcereply.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/forcereply.py + telegram.ForceReply =================== diff --git a/docs/source/telegram.game.rst b/docs/source/telegram.game.rst index ada1140d5..c6f2c51c1 100644 --- a/docs/source/telegram.game.rst +++ b/docs/source/telegram.game.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/game.py + telegram.Game ============= diff --git a/docs/source/telegram.gamehighscore.rst b/docs/source/telegram.gamehighscore.rst index c69c7fe1d..84528bdb9 100644 --- a/docs/source/telegram.gamehighscore.rst +++ b/docs/source/telegram.gamehighscore.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/gamehighscore.py + telegram.GameHighScore ====================== diff --git a/docs/source/telegram.iddocumentdata.rst b/docs/source/telegram.iddocumentdata.rst index 1333f7ed4..85c32271a 100644 --- a/docs/source/telegram.iddocumentdata.rst +++ b/docs/source/telegram.iddocumentdata.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py + telegram.IdDocumentData ======================= diff --git a/docs/source/telegram.inlinekeyboardbutton.rst b/docs/source/telegram.inlinekeyboardbutton.rst index 9a118a75c..dde7af030 100644 --- a/docs/source/telegram.inlinekeyboardbutton.rst +++ b/docs/source/telegram.inlinekeyboardbutton.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinekeyboardbutton.py + telegram.InlineKeyboardButton ============================= diff --git a/docs/source/telegram.inlinekeyboardmarkup.rst b/docs/source/telegram.inlinekeyboardmarkup.rst index 63aba4630..1a41e0d1d 100644 --- a/docs/source/telegram.inlinekeyboardmarkup.rst +++ b/docs/source/telegram.inlinekeyboardmarkup.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinekeyboardmarkup.py + telegram.InlineKeyboardMarkup ============================= diff --git a/docs/source/telegram.inlinequery.rst b/docs/source/telegram.inlinequery.rst index ce17a816d..00c6566a9 100644 --- a/docs/source/telegram.inlinequery.rst +++ b/docs/source/telegram.inlinequery.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequery.py + telegram.InlineQuery ==================== diff --git a/docs/source/telegram.inlinequeryresult.rst b/docs/source/telegram.inlinequeryresult.rst index 97e9a97ff..0d9970b1a 100644 --- a/docs/source/telegram.inlinequeryresult.rst +++ b/docs/source/telegram.inlinequeryresult.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresult.py + telegram.InlineQueryResult ========================== diff --git a/docs/source/telegram.inlinequeryresultarticle.rst b/docs/source/telegram.inlinequeryresultarticle.rst index c8756fdc7..46ea88cd7 100644 --- a/docs/source/telegram.inlinequeryresultarticle.rst +++ b/docs/source/telegram.inlinequeryresultarticle.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultarticle.py + telegram.InlineQueryResultArticle ================================= diff --git a/docs/source/telegram.inlinequeryresultaudio.rst b/docs/source/telegram.inlinequeryresultaudio.rst index 83bb5d452..414b437c7 100644 --- a/docs/source/telegram.inlinequeryresultaudio.rst +++ b/docs/source/telegram.inlinequeryresultaudio.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultaudio.py + telegram.InlineQueryResultAudio =============================== diff --git a/docs/source/telegram.inlinequeryresultcachedaudio.rst b/docs/source/telegram.inlinequeryresultcachedaudio.rst index f7e992916..01431917a 100644 --- a/docs/source/telegram.inlinequeryresultcachedaudio.rst +++ b/docs/source/telegram.inlinequeryresultcachedaudio.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedaudio.py + telegram.InlineQueryResultCachedAudio ===================================== diff --git a/docs/source/telegram.inlinequeryresultcacheddocument.rst b/docs/source/telegram.inlinequeryresultcacheddocument.rst index 18db7ba7a..5a23a317e 100644 --- a/docs/source/telegram.inlinequeryresultcacheddocument.rst +++ b/docs/source/telegram.inlinequeryresultcacheddocument.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcacheddocument.py + telegram.InlineQueryResultCachedDocument ======================================== diff --git a/docs/source/telegram.inlinequeryresultcachedgif.rst b/docs/source/telegram.inlinequeryresultcachedgif.rst index 9faaf071a..a639991db 100644 --- a/docs/source/telegram.inlinequeryresultcachedgif.rst +++ b/docs/source/telegram.inlinequeryresultcachedgif.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedgif.py + telegram.InlineQueryResultCachedGif =================================== diff --git a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst index 1c6406ab5..d98da7434 100644 --- a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst +++ b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedmpeg4gif.py + telegram.InlineQueryResultCachedMpeg4Gif ======================================== diff --git a/docs/source/telegram.inlinequeryresultcachedphoto.rst b/docs/source/telegram.inlinequeryresultcachedphoto.rst index 9887210f3..882f84ce4 100644 --- a/docs/source/telegram.inlinequeryresultcachedphoto.rst +++ b/docs/source/telegram.inlinequeryresultcachedphoto.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedphoto.py + telegram.InlineQueryResultCachedPhoto ===================================== diff --git a/docs/source/telegram.inlinequeryresultcachedsticker.rst b/docs/source/telegram.inlinequeryresultcachedsticker.rst index 4b989ddba..19872be36 100644 --- a/docs/source/telegram.inlinequeryresultcachedsticker.rst +++ b/docs/source/telegram.inlinequeryresultcachedsticker.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedsticker.py + telegram.InlineQueryResultCachedSticker ======================================= diff --git a/docs/source/telegram.inlinequeryresultcachedvideo.rst b/docs/source/telegram.inlinequeryresultcachedvideo.rst index 49efa7e89..567b86b71 100644 --- a/docs/source/telegram.inlinequeryresultcachedvideo.rst +++ b/docs/source/telegram.inlinequeryresultcachedvideo.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedvideo.py + telegram.InlineQueryResultCachedVideo ===================================== diff --git a/docs/source/telegram.inlinequeryresultcachedvoice.rst b/docs/source/telegram.inlinequeryresultcachedvoice.rst index 88a5377c8..c26bf1872 100644 --- a/docs/source/telegram.inlinequeryresultcachedvoice.rst +++ b/docs/source/telegram.inlinequeryresultcachedvoice.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedvoice.py + telegram.InlineQueryResultCachedVoice ===================================== diff --git a/docs/source/telegram.inlinequeryresultcontact.rst b/docs/source/telegram.inlinequeryresultcontact.rst index 017ccfbca..cd40f9fe8 100644 --- a/docs/source/telegram.inlinequeryresultcontact.rst +++ b/docs/source/telegram.inlinequeryresultcontact.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcontact.py + telegram.InlineQueryResultContact ================================= diff --git a/docs/source/telegram.inlinequeryresultdocument.rst b/docs/source/telegram.inlinequeryresultdocument.rst index ec8542260..7cdd4601f 100644 --- a/docs/source/telegram.inlinequeryresultdocument.rst +++ b/docs/source/telegram.inlinequeryresultdocument.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultdocument.py + telegram.InlineQueryResultDocument ================================== diff --git a/docs/source/telegram.inlinequeryresultgame.rst b/docs/source/telegram.inlinequeryresultgame.rst index 7c6172d80..dbc57c9de 100644 --- a/docs/source/telegram.inlinequeryresultgame.rst +++ b/docs/source/telegram.inlinequeryresultgame.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultgame.py + telegram.InlineQueryResultGame ============================== diff --git a/docs/source/telegram.inlinequeryresultgif.rst b/docs/source/telegram.inlinequeryresultgif.rst index a9c60f143..eb02ae709 100644 --- a/docs/source/telegram.inlinequeryresultgif.rst +++ b/docs/source/telegram.inlinequeryresultgif.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultgif.py + telegram.InlineQueryResultGif ============================= diff --git a/docs/source/telegram.inlinequeryresultlocation.rst b/docs/source/telegram.inlinequeryresultlocation.rst index 37980636d..49622306a 100644 --- a/docs/source/telegram.inlinequeryresultlocation.rst +++ b/docs/source/telegram.inlinequeryresultlocation.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultlocation.py + telegram.InlineQueryResultLocation ================================== diff --git a/docs/source/telegram.inlinequeryresultmpeg4gif.rst b/docs/source/telegram.inlinequeryresultmpeg4gif.rst index ad7e12d47..72d87c822 100644 --- a/docs/source/telegram.inlinequeryresultmpeg4gif.rst +++ b/docs/source/telegram.inlinequeryresultmpeg4gif.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultmpeg4gif.py + telegram.InlineQueryResultMpeg4Gif ================================== diff --git a/docs/source/telegram.inlinequeryresultphoto.rst b/docs/source/telegram.inlinequeryresultphoto.rst index 40a9f63c3..9e6edd7f4 100644 --- a/docs/source/telegram.inlinequeryresultphoto.rst +++ b/docs/source/telegram.inlinequeryresultphoto.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultphoto.py + telegram.InlineQueryResultPhoto =============================== diff --git a/docs/source/telegram.inlinequeryresultvenue.rst b/docs/source/telegram.inlinequeryresultvenue.rst index 4378ed478..50e026353 100644 --- a/docs/source/telegram.inlinequeryresultvenue.rst +++ b/docs/source/telegram.inlinequeryresultvenue.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvenue.py + telegram.InlineQueryResultVenue =============================== diff --git a/docs/source/telegram.inlinequeryresultvideo.rst b/docs/source/telegram.inlinequeryresultvideo.rst index 3cb445fd0..d760dda18 100644 --- a/docs/source/telegram.inlinequeryresultvideo.rst +++ b/docs/source/telegram.inlinequeryresultvideo.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvideo.py + telegram.InlineQueryResultVideo =============================== diff --git a/docs/source/telegram.inlinequeryresultvoice.rst b/docs/source/telegram.inlinequeryresultvoice.rst index e3efd0717..2e7c139b3 100644 --- a/docs/source/telegram.inlinequeryresultvoice.rst +++ b/docs/source/telegram.inlinequeryresultvoice.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvoice.py + telegram.InlineQueryResultVoice =============================== diff --git a/docs/source/telegram.inputcontactmessagecontent.rst b/docs/source/telegram.inputcontactmessagecontent.rst index 3a98e7e98..d26eaebc3 100644 --- a/docs/source/telegram.inputcontactmessagecontent.rst +++ b/docs/source/telegram.inputcontactmessagecontent.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputcontactmessagecontent.py + telegram.InputContactMessageContent =================================== diff --git a/docs/source/telegram.inputfile.rst b/docs/source/telegram.inputfile.rst index cd55a869c..7462feff4 100644 --- a/docs/source/telegram.inputfile.rst +++ b/docs/source/telegram.inputfile.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputfile.py + telegram.InputFile ================== diff --git a/docs/source/telegram.inputlocationmessagecontent.rst b/docs/source/telegram.inputlocationmessagecontent.rst index b5bc314e2..40db11ceb 100644 --- a/docs/source/telegram.inputlocationmessagecontent.rst +++ b/docs/source/telegram.inputlocationmessagecontent.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputlocationmessagecontent.py + telegram.InputLocationMessageContent ==================================== diff --git a/docs/source/telegram.inputmedia.rst b/docs/source/telegram.inputmedia.rst index 26b9d76eb..5d3e96cf1 100644 --- a/docs/source/telegram.inputmedia.rst +++ b/docs/source/telegram.inputmedia.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py + telegram.InputMedia =================== diff --git a/docs/source/telegram.inputmediaanimation.rst b/docs/source/telegram.inputmediaanimation.rst index b94711b06..ca0f302bf 100644 --- a/docs/source/telegram.inputmediaanimation.rst +++ b/docs/source/telegram.inputmediaanimation.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py + telegram.InputMediaAnimation ============================ diff --git a/docs/source/telegram.inputmediaaudio.rst b/docs/source/telegram.inputmediaaudio.rst index 5a7a977fc..9340ae86e 100644 --- a/docs/source/telegram.inputmediaaudio.rst +++ b/docs/source/telegram.inputmediaaudio.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py + telegram.InputMediaAudio ======================== diff --git a/docs/source/telegram.inputmediadocument.rst b/docs/source/telegram.inputmediadocument.rst index 746b15f9a..7fa547ded 100644 --- a/docs/source/telegram.inputmediadocument.rst +++ b/docs/source/telegram.inputmediadocument.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py + telegram.InputMediaDocument =========================== diff --git a/docs/source/telegram.inputmediaphoto.rst b/docs/source/telegram.inputmediaphoto.rst index 07bfe307f..11dc5e99d 100644 --- a/docs/source/telegram.inputmediaphoto.rst +++ b/docs/source/telegram.inputmediaphoto.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py + telegram.InputMediaPhoto ======================== diff --git a/docs/source/telegram.inputmediavideo.rst b/docs/source/telegram.inputmediavideo.rst index af28e4667..6f6a12880 100644 --- a/docs/source/telegram.inputmediavideo.rst +++ b/docs/source/telegram.inputmediavideo.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py + telegram.InputMediaVideo ======================== diff --git a/docs/source/telegram.inputmessagecontent.rst b/docs/source/telegram.inputmessagecontent.rst index 374510996..26efa6063 100644 --- a/docs/source/telegram.inputmessagecontent.rst +++ b/docs/source/telegram.inputmessagecontent.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputmessagecontent.py + telegram.InputMessageContent ============================ diff --git a/docs/source/telegram.inputtextmessagecontent.rst b/docs/source/telegram.inputtextmessagecontent.rst index 88d7972f4..992f02eed 100644 --- a/docs/source/telegram.inputtextmessagecontent.rst +++ b/docs/source/telegram.inputtextmessagecontent.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputtextmessagecontent.py + telegram.InputTextMessageContent ================================ diff --git a/docs/source/telegram.inputvenuemessagecontent.rst b/docs/source/telegram.inputvenuemessagecontent.rst index 009a39920..ba91631e1 100644 --- a/docs/source/telegram.inputvenuemessagecontent.rst +++ b/docs/source/telegram.inputvenuemessagecontent.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputvenuemessagecontent.py + telegram.InputVenueMessageContent ================================= diff --git a/docs/source/telegram.invoice.rst b/docs/source/telegram.invoice.rst index f38c4e6c7..f5af48a06 100644 --- a/docs/source/telegram.invoice.rst +++ b/docs/source/telegram.invoice.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/invoice.py + telegram.Invoice ================ diff --git a/docs/source/telegram.keyboardbutton.rst b/docs/source/telegram.keyboardbutton.rst index cec3de5d7..ccb5b508b 100644 --- a/docs/source/telegram.keyboardbutton.rst +++ b/docs/source/telegram.keyboardbutton.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/keyboardbutton.py + telegram.KeyboardButton ======================= diff --git a/docs/source/telegram.keyboardbuttonpolltype.rst b/docs/source/telegram.keyboardbuttonpolltype.rst index fa4315abd..1c4ef7f2d 100644 --- a/docs/source/telegram.keyboardbuttonpolltype.rst +++ b/docs/source/telegram.keyboardbuttonpolltype.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/keyboardbuttonpolltype.py + telegram.KeyboardButtonPollType =============================== diff --git a/docs/source/telegram.labeledprice.rst b/docs/source/telegram.labeledprice.rst index 7c9d5668a..046cde062 100644 --- a/docs/source/telegram.labeledprice.rst +++ b/docs/source/telegram.labeledprice.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/labeledprice.py + telegram.LabeledPrice ===================== diff --git a/docs/source/telegram.location.rst b/docs/source/telegram.location.rst index 7d3a62c21..22effdd0b 100644 --- a/docs/source/telegram.location.rst +++ b/docs/source/telegram.location.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/location.py + telegram.Location ================= diff --git a/docs/source/telegram.loginurl.rst b/docs/source/telegram.loginurl.rst index 3f8324d95..2a39d661e 100644 --- a/docs/source/telegram.loginurl.rst +++ b/docs/source/telegram.loginurl.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/loginurl.py + telegram.LoginUrl ================= diff --git a/docs/source/telegram.maskposition.rst b/docs/source/telegram.maskposition.rst index d38bb3445..f54fb5ea5 100644 --- a/docs/source/telegram.maskposition.rst +++ b/docs/source/telegram.maskposition.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py + telegram.MaskPosition ===================== diff --git a/docs/source/telegram.message.rst b/docs/source/telegram.message.rst index 97259744c..91e3fe39a 100644 --- a/docs/source/telegram.message.rst +++ b/docs/source/telegram.message.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/message.py + telegram.Message ================ diff --git a/docs/source/telegram.messageautodeletetimerchanged.rst b/docs/source/telegram.messageautodeletetimerchanged.rst index ae1fd5472..3553f7d9f 100644 --- a/docs/source/telegram.messageautodeletetimerchanged.rst +++ b/docs/source/telegram.messageautodeletetimerchanged.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageautodeletetimerchanged.py + telegram.MessageAutoDeleteTimerChanged ====================================== diff --git a/docs/source/telegram.messageentity.rst b/docs/source/telegram.messageentity.rst index 9e3fce97b..a9a9c421e 100644 --- a/docs/source/telegram.messageentity.rst +++ b/docs/source/telegram.messageentity.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageentity.py + telegram.MessageEntity ====================== diff --git a/docs/source/telegram.messageid.rst b/docs/source/telegram.messageid.rst index 9df1de2a1..1fb908661 100644 --- a/docs/source/telegram.messageid.rst +++ b/docs/source/telegram.messageid.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageid.py + telegram.MessageId ================== diff --git a/docs/source/telegram.orderinfo.rst b/docs/source/telegram.orderinfo.rst index 28741db79..981768981 100644 --- a/docs/source/telegram.orderinfo.rst +++ b/docs/source/telegram.orderinfo.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/orderinfo.py + telegram.OrderInfo ================== diff --git a/docs/source/telegram.parsemode.rst b/docs/source/telegram.parsemode.rst index 02ab2f379..5d493949b 100644 --- a/docs/source/telegram.parsemode.rst +++ b/docs/source/telegram.parsemode.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/parsemode.py + telegram.ParseMode ================== diff --git a/docs/source/telegram.passportdata.rst b/docs/source/telegram.passportdata.rst index 43a33b560..92b033e40 100644 --- a/docs/source/telegram.passportdata.rst +++ b/docs/source/telegram.passportdata.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportdata.py + telegram.PassportData ===================== diff --git a/docs/source/telegram.passportelementerror.rst b/docs/source/telegram.passportelementerror.rst index 00ef430d7..b431f05d8 100644 --- a/docs/source/telegram.passportelementerror.rst +++ b/docs/source/telegram.passportelementerror.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + telegram.PassportElementError ============================= diff --git a/docs/source/telegram.passportelementerrordatafield.rst b/docs/source/telegram.passportelementerrordatafield.rst index ac304f7b5..8868e6b15 100644 --- a/docs/source/telegram.passportelementerrordatafield.rst +++ b/docs/source/telegram.passportelementerrordatafield.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + telegram.PassportElementErrorDataField ====================================== diff --git a/docs/source/telegram.passportelementerrorfile.rst b/docs/source/telegram.passportelementerrorfile.rst index 339d7a786..cb7432330 100644 --- a/docs/source/telegram.passportelementerrorfile.rst +++ b/docs/source/telegram.passportelementerrorfile.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + telegram.PassportElementErrorFile ================================= diff --git a/docs/source/telegram.passportelementerrorfiles.rst b/docs/source/telegram.passportelementerrorfiles.rst index f9643d969..a6ed2e4a1 100644 --- a/docs/source/telegram.passportelementerrorfiles.rst +++ b/docs/source/telegram.passportelementerrorfiles.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + telegram.PassportElementErrorFiles ================================== diff --git a/docs/source/telegram.passportelementerrorfrontside.rst b/docs/source/telegram.passportelementerrorfrontside.rst index a92635a27..3e57cf2cd 100644 --- a/docs/source/telegram.passportelementerrorfrontside.rst +++ b/docs/source/telegram.passportelementerrorfrontside.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + telegram.PassportElementErrorFrontSide ====================================== diff --git a/docs/source/telegram.passportelementerrorreverseside.rst b/docs/source/telegram.passportelementerrorreverseside.rst index 380a10664..089eaffb0 100644 --- a/docs/source/telegram.passportelementerrorreverseside.rst +++ b/docs/source/telegram.passportelementerrorreverseside.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + telegram.PassportElementErrorReverseSide ======================================== diff --git a/docs/source/telegram.passportelementerrorselfie.rst b/docs/source/telegram.passportelementerrorselfie.rst new file mode 100644 index 000000000..a29b72f5b --- /dev/null +++ b/docs/source/telegram.passportelementerrorselfie.rst @@ -0,0 +1,8 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + +telegram.PassportElementErrorSelfie +======================================== + +.. autoclass:: telegram.PassportElementErrorSelfie + :members: + :show-inheritance: diff --git a/docs/source/telegram.passportelementerrortranslationfile.rst b/docs/source/telegram.passportelementerrortranslationfile.rst new file mode 100644 index 000000000..df48052ec --- /dev/null +++ b/docs/source/telegram.passportelementerrortranslationfile.rst @@ -0,0 +1,8 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + +telegram.PassportElementErrorTranslationFile +============================================ + +.. autoclass:: telegram.PassportElementErrorTranslationFile + :members: + :show-inheritance: diff --git a/docs/source/telegram.passportelementerrortranslationfiles.rst b/docs/source/telegram.passportelementerrortranslationfiles.rst new file mode 100644 index 000000000..50c59a4df --- /dev/null +++ b/docs/source/telegram.passportelementerrortranslationfiles.rst @@ -0,0 +1,8 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + +telegram.PassportElementErrorTranslationFiles +============================================= + +.. autoclass:: telegram.PassportElementErrorTranslationFiles + :members: + :show-inheritance: diff --git a/docs/source/telegram.passportelementerrorunspecified.rst b/docs/source/telegram.passportelementerrorunspecified.rst new file mode 100644 index 000000000..cca808144 --- /dev/null +++ b/docs/source/telegram.passportelementerrorunspecified.rst @@ -0,0 +1,8 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py + +telegram.PassportElementErrorUnspecified +======================================== + +.. autoclass:: telegram.PassportElementErrorUnspecified + :members: + :show-inheritance: diff --git a/docs/source/telegram.passportfile.rst b/docs/source/telegram.passportfile.rst index a2af1c5f6..e5577215e 100644 --- a/docs/source/telegram.passportfile.rst +++ b/docs/source/telegram.passportfile.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportfile.py + telegram.PassportFile ===================== diff --git a/docs/source/telegram.personaldetails.rst b/docs/source/telegram.personaldetails.rst index 145769f23..7a072b51c 100644 --- a/docs/source/telegram.personaldetails.rst +++ b/docs/source/telegram.personaldetails.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py + telegram.PersonalDetails ======================== diff --git a/docs/source/telegram.photosize.rst b/docs/source/telegram.photosize.rst index 96ec72e03..8b9b20aee 100644 --- a/docs/source/telegram.photosize.rst +++ b/docs/source/telegram.photosize.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/photosize.py + telegram.PhotoSize ================== diff --git a/docs/source/telegram.poll.rst b/docs/source/telegram.poll.rst index cd369a027..ed401d707 100644 --- a/docs/source/telegram.poll.rst +++ b/docs/source/telegram.poll.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py + telegram.Poll ============= diff --git a/docs/source/telegram.pollanswer.rst b/docs/source/telegram.pollanswer.rst index b74899ebf..a72a89340 100644 --- a/docs/source/telegram.pollanswer.rst +++ b/docs/source/telegram.pollanswer.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py + telegram.PollAnswer =================== diff --git a/docs/source/telegram.polloption.rst b/docs/source/telegram.polloption.rst index 53a6cd69e..02663e932 100644 --- a/docs/source/telegram.polloption.rst +++ b/docs/source/telegram.polloption.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py + telegram.PollOption =================== diff --git a/docs/source/telegram.precheckoutquery.rst b/docs/source/telegram.precheckoutquery.rst index 1b3893981..2bac6fa57 100644 --- a/docs/source/telegram.precheckoutquery.rst +++ b/docs/source/telegram.precheckoutquery.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/precheckoutquery.py + telegram.PreCheckoutQuery ========================= diff --git a/docs/source/telegram.proximityalerttriggered.rst b/docs/source/telegram.proximityalerttriggered.rst index ab01987ab..251f3a53f 100644 --- a/docs/source/telegram.proximityalerttriggered.rst +++ b/docs/source/telegram.proximityalerttriggered.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/proximityalerttriggered.py + telegram.ProximityAlertTriggered ================================ diff --git a/docs/source/telegram.replykeyboardmarkup.rst b/docs/source/telegram.replykeyboardmarkup.rst index 8f55975ea..87ff3af9f 100644 --- a/docs/source/telegram.replykeyboardmarkup.rst +++ b/docs/source/telegram.replykeyboardmarkup.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/replykeyboardmarkup.py + telegram.ReplyKeyboardMarkup ============================ diff --git a/docs/source/telegram.replykeyboardremove.rst b/docs/source/telegram.replykeyboardremove.rst index 0f318d2ca..7e7235b0c 100644 --- a/docs/source/telegram.replykeyboardremove.rst +++ b/docs/source/telegram.replykeyboardremove.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/replykeyboardremove.py + telegram.ReplyKeyboardRemove ============================ diff --git a/docs/source/telegram.replymarkup.rst b/docs/source/telegram.replymarkup.rst index 761c8ca16..ba262b6b9 100644 --- a/docs/source/telegram.replymarkup.rst +++ b/docs/source/telegram.replymarkup.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/replymarkup.py + telegram.ReplyMarkup ==================== diff --git a/docs/source/telegram.residentialaddress.rst b/docs/source/telegram.residentialaddress.rst index 95be56963..6243af42c 100644 --- a/docs/source/telegram.residentialaddress.rst +++ b/docs/source/telegram.residentialaddress.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py + telegram.ResidentialAddress =========================== diff --git a/docs/source/telegram.rst b/docs/source/telegram.rst index f51bf9665..1cb0289f0 100644 --- a/docs/source/telegram.rst +++ b/docs/source/telegram.rst @@ -1,6 +1,3 @@ -.. include:: telegram.ext.rst - - telegram package ================ @@ -140,11 +137,14 @@ Passport telegram.passportelementerror telegram.passportelementerrorfile + telegram.passportelementerrorfiles telegram.passportelementerrorreverseside telegram.passportelementerrorfrontside - telegram.passportelementerrorfiles telegram.passportelementerrordatafield - telegram.passportelementerrorfile + telegram.passportelementerrorselfie + telegram.passportelementerrortranslationfile + telegram.passportelementerrortranslationfiles + telegram.passportelementerrorunspecified telegram.credentials telegram.datacredentials telegram.securedata @@ -158,4 +158,12 @@ Passport telegram.encryptedpassportelement telegram.encryptedcredentials -.. include:: telegram.utils.rst +utils +----- + +.. toctree:: + + telegram.utils.helpers + telegram.utils.promise + telegram.utils.request + telegram.utils.types diff --git a/docs/source/telegram.securedata.rst b/docs/source/telegram.securedata.rst index ec24c8c4c..29091caa2 100644 --- a/docs/source/telegram.securedata.rst +++ b/docs/source/telegram.securedata.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py + telegram.SecureData =================== diff --git a/docs/source/telegram.securevalue.rst b/docs/source/telegram.securevalue.rst index ba756a2cc..f9ca37a3b 100644 --- a/docs/source/telegram.securevalue.rst +++ b/docs/source/telegram.securevalue.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py + telegram.SecureValue ==================== diff --git a/docs/source/telegram.shippingaddress.rst b/docs/source/telegram.shippingaddress.rst index 6b89c4f86..c6cee4571 100644 --- a/docs/source/telegram.shippingaddress.rst +++ b/docs/source/telegram.shippingaddress.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingaddress.py + telegram.ShippingAddress ======================== diff --git a/docs/source/telegram.shippingoption.rst b/docs/source/telegram.shippingoption.rst index f0af54f85..64024ba90 100644 --- a/docs/source/telegram.shippingoption.rst +++ b/docs/source/telegram.shippingoption.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingoption.py + telegram.ShippingOption ======================= diff --git a/docs/source/telegram.shippingquery.rst b/docs/source/telegram.shippingquery.rst index 5e3c6fd13..d2bf7889c 100644 --- a/docs/source/telegram.shippingquery.rst +++ b/docs/source/telegram.shippingquery.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingquery.py + telegram.ShippingQuery ====================== diff --git a/docs/source/telegram.sticker.rst b/docs/source/telegram.sticker.rst index 402d1b21b..d5c8f90c3 100644 --- a/docs/source/telegram.sticker.rst +++ b/docs/source/telegram.sticker.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py + telegram.Sticker ================ diff --git a/docs/source/telegram.stickerset.rst b/docs/source/telegram.stickerset.rst index 3705c2ef8..1c0f77cb2 100644 --- a/docs/source/telegram.stickerset.rst +++ b/docs/source/telegram.stickerset.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py + telegram.StickerSet =================== diff --git a/docs/source/telegram.successfulpayment.rst b/docs/source/telegram.successfulpayment.rst index 43228b505..c703bd692 100644 --- a/docs/source/telegram.successfulpayment.rst +++ b/docs/source/telegram.successfulpayment.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/successfulpayment.py + telegram.SuccessfulPayment ========================== diff --git a/docs/source/telegram.update.rst b/docs/source/telegram.update.rst index 48e1e18be..f8a5d69be 100644 --- a/docs/source/telegram.update.rst +++ b/docs/source/telegram.update.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/update.py + telegram.Update =============== diff --git a/docs/source/telegram.user.rst b/docs/source/telegram.user.rst index e5c74e737..23fc2d3f3 100644 --- a/docs/source/telegram.user.rst +++ b/docs/source/telegram.user.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/user.py + telegram.User ============= diff --git a/docs/source/telegram.userprofilephotos.rst b/docs/source/telegram.userprofilephotos.rst index 8ca19882e..be0cd388e 100644 --- a/docs/source/telegram.userprofilephotos.rst +++ b/docs/source/telegram.userprofilephotos.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/userprofilephotos.py + telegram.UserProfilePhotos ========================== diff --git a/docs/source/telegram.utils.helpers.rst b/docs/source/telegram.utils.helpers.rst index ce3e0de7d..fe7ffc553 100644 --- a/docs/source/telegram.utils.helpers.rst +++ b/docs/source/telegram.utils.helpers.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/utils/helpers.py + telegram.utils.helpers Module ============================= diff --git a/docs/source/telegram.utils.request.rst b/docs/source/telegram.utils.request.rst index 8efebf2c3..ac0618720 100644 --- a/docs/source/telegram.utils.request.rst +++ b/docs/source/telegram.utils.request.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/utils/request.py + telegram.utils.request.Request ============================== diff --git a/docs/source/telegram.utils.rst b/docs/source/telegram.utils.rst deleted file mode 100644 index 619918b1a..000000000 --- a/docs/source/telegram.utils.rst +++ /dev/null @@ -1,9 +0,0 @@ -telegram.utils package -====================== - -.. toctree:: - - telegram.utils.helpers - telegram.utils.promise - telegram.utils.request - telegram.utils.types diff --git a/docs/source/telegram.utils.types.rst b/docs/source/telegram.utils.types.rst index fd1c0252b..97f88ce43 100644 --- a/docs/source/telegram.utils.types.rst +++ b/docs/source/telegram.utils.types.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/utils/types.py + telegram.utils.types Module =========================== diff --git a/docs/source/telegram.venue.rst b/docs/source/telegram.venue.rst index 0cba4d0d1..a0322f471 100644 --- a/docs/source/telegram.venue.rst +++ b/docs/source/telegram.venue.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/venue.py + telegram.Venue ============== diff --git a/docs/source/telegram.video.rst b/docs/source/telegram.video.rst index e9c7cd71d..6030a1b76 100644 --- a/docs/source/telegram.video.rst +++ b/docs/source/telegram.video.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/video.py + telegram.Video ============== diff --git a/docs/source/telegram.videonote.rst b/docs/source/telegram.videonote.rst index 52b25280f..ca0f99f53 100644 --- a/docs/source/telegram.videonote.rst +++ b/docs/source/telegram.videonote.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/videonote.py + telegram.VideoNote ================== diff --git a/docs/source/telegram.voice.rst b/docs/source/telegram.voice.rst index 81a49ad5d..9489eb0f6 100644 --- a/docs/source/telegram.voice.rst +++ b/docs/source/telegram.voice.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/voice.py + telegram.Voice ============== diff --git a/docs/source/telegram.voicechatended.rst b/docs/source/telegram.voicechatended.rst index 1183f632f..f65584884 100644 --- a/docs/source/telegram.voicechatended.rst +++ b/docs/source/telegram.voicechatended.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/voicechat.py + telegram.VoiceChatEnded ======================= diff --git a/docs/source/telegram.voicechatparticipantsinvited.rst b/docs/source/telegram.voicechatparticipantsinvited.rst index c2e70a9a8..7f3bb45c5 100644 --- a/docs/source/telegram.voicechatparticipantsinvited.rst +++ b/docs/source/telegram.voicechatparticipantsinvited.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/voicechat.py + telegram.VoiceChatParticipantsInvited ===================================== diff --git a/docs/source/telegram.voicechatstarted.rst b/docs/source/telegram.voicechatstarted.rst index 31981b95a..eeae2dfef 100644 --- a/docs/source/telegram.voicechatstarted.rst +++ b/docs/source/telegram.voicechatstarted.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/voicechat.py + telegram.VoiceChatStarted ========================= diff --git a/docs/source/telegram.webhookinfo.rst b/docs/source/telegram.webhookinfo.rst index 233b76637..fabf0e6e7 100644 --- a/docs/source/telegram.webhookinfo.rst +++ b/docs/source/telegram.webhookinfo.rst @@ -1,3 +1,5 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/webhookinfo.py + telegram.WebhookInfo ==================== diff --git a/examples/README.md b/examples/README.md index 4c67c7c25..5b05c53ef 100644 --- a/examples/README.md +++ b/examples/README.md @@ -23,7 +23,7 @@ A even more complex example of a bot that uses the nested `ConversationHandler`s A basic example of a bot store conversation state and user_data over multiple restarts. ### [`inlinekeyboard.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/inlinekeyboard.py) -This example sheds some light on inline keyboards, callback queries and message editing. +This example sheds some light on inline keyboards, callback queries and message editing. A wikipedia site explaining this examples lives at https://git.io/JOmFw. ### [`inlinekeyboard2.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/inlinekeyboard2.py) A more complex example about inline keyboards, callback queries and message editing. This example showcases how an interactive menu could be build using inline keyboards. diff --git a/examples/inlinekeyboard.py b/examples/inlinekeyboard.py index d5f88c27a..1305dc106 100644 --- a/examples/inlinekeyboard.py +++ b/examples/inlinekeyboard.py @@ -3,7 +3,8 @@ # This program is dedicated to the public domain under the CC0 license. """ -Basic example for a bot that uses inline keyboards. +Basic example for a bot that uses inline keyboards. For an in-depth explanation, check out + https://git.io/JOmFw. """ import logging diff --git a/telegram/bot.py b/telegram/bot.py index 70228ca47..b306d0c8b 100644 --- a/telegram/bot.py +++ b/telegram/bot.py @@ -356,19 +356,19 @@ class Bot(TelegramObject): @property def can_join_groups(self) -> bool: - """:obj:`bool`: Bot's can_join_groups attribute.""" + """:obj:`bool`: Bot's :attr:`telegram.User.can_join_groups` attribute.""" return self.bot.can_join_groups # type: ignore @property def can_read_all_group_messages(self) -> bool: - """:obj:`bool`: Bot's can_read_all_group_messages attribute.""" + """:obj:`bool`: Bot's :attr:`telegram.User.can_read_all_group_messages` attribute.""" return self.bot.can_read_all_group_messages # type: ignore @property def supports_inline_queries(self) -> bool: - """:obj:`bool`: Bot's supports_inline_queries attribute.""" + """:obj:`bool`: Bot's :attr:`telegram.User.supports_inline_queries` attribute.""" return self.bot.supports_inline_queries # type: ignore @@ -430,7 +430,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). text (:obj:`str`): Text of the message to be sent. Max 4096 characters after entities parsing. Also found as :attr:`telegram.constants.MAX_MESSAGE_LENGTH`. parse_mode (:obj:`str`): Send Markdown or HTML, if you want Telegram apps to show bold, @@ -500,14 +500,15 @@ class Bot(TelegramObject): hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - - Bots granted can_post_messages permissions can delete outgoing messages in channels. + - Bots granted :attr:`telegram.ChatMember.can_post_messages` permissions can delete + outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - - If the bot has can_delete_messages permission in a supergroup or a channel, it can - delete any message there. + - If the bot has :attr:`telegram.ChatMember.can_delete_messages` permission in a + supergroup or a channel, it can delete any message there. Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). message_id (:obj:`int`): Identifier of the message to delete. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of @@ -542,12 +543,12 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). from_chat_id (:obj:`int` | :obj:`str`): Unique identifier for the chat where the - original message was sent (or channel username in the format @channelusername). + original message was sent (or channel username in the format ``@channelusername``). + message_id (:obj:`int`): Message identifier in the chat specified in from_chat_id. disable_notification (:obj:`bool`, optional): Sends the message silently. Users will receive a notification with no sound. - message_id (:obj:`int`): Message identifier in the chat specified in from_chat_id. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -602,7 +603,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). photo (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path` | \ :class:`telegram.PhotoSize`): Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers @@ -695,7 +696,7 @@ class Bot(TelegramObject): Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. - For sending voice messages, use the sendVoice method instead. + For sending voice messages, use the :meth:`send_voice` method instead. Note: The audio argument can be either a file_id, an URL or a file from disk @@ -703,7 +704,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). audio (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path` | \ :class:`telegram.Audio`): Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers @@ -819,7 +820,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). document (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path` | \ :class:`telegram.Document`): File to send. Pass a file_id as String to send a file that exists on the Telegram servers @@ -919,7 +920,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path` | \ :class:`telegram.Sticker`): Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers @@ -999,7 +1000,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). video (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path` | \ :class:`telegram.Video`): Video file to send. Pass a file_id as String to send an video file that exists on the Telegram servers @@ -1117,7 +1118,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). video_note (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path` | \ :class:`telegram.VideoNote`): Video note to send. Pass a file_id as String to send a video note that exists on the Telegram @@ -1219,7 +1220,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). animation (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path` | \ :class:`telegram.Animation`): Animation to send. Pass a file_id as String to send an animation that exists on the Telegram @@ -1333,7 +1334,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). voice (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path` | \ :class:`telegram.Voice`): Voice file to send. Pass a file_id as String to send an voice file that exists on the Telegram servers @@ -1419,7 +1420,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). media (List[:class:`telegram.InputMediaAudio`, :class:`telegram.InputMediaDocument`, \ :class:`telegram.InputMediaPhoto`, :class:`telegram.InputMediaVideo`]): An array describing messages to be sent, must include 2–10 items. @@ -1485,7 +1486,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). latitude (:obj:`float`, optional): Latitude of location. longitude (:obj:`float`, optional): Longitude of location. location (:class:`telegram.Location`, optional): The location to send. @@ -1573,8 +1574,8 @@ class Bot(TelegramObject): proximity_alert_radius: int = None, ) -> Union[Message, bool]: """Use this method to edit live location messages sent by the bot or via the bot - (for inline bots). A location can be edited until its :attr:`live_period` expires or - editing is explicitly disabled by a call to :meth:`stop_message_live_location`. + (for inline bots). A location can be edited until its :attr:`telegram.Location.live_period` + expires or editing is explicitly disabled by a call to :meth:`stop_message_live_location`. Note: You can either supply a :obj:`latitude` and :obj:`longitude` or a :obj:`location`. @@ -1582,7 +1583,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`, optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel - (in the format @channelusername). + (in the format ``@channelusername``). message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not @@ -1661,7 +1662,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel - (in the format @channelusername). + (in the format ``@channelusername``). message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the sent message with live location to stop. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not @@ -1727,7 +1728,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). latitude (:obj:`float`, optional): Latitude of venue. longitude (:obj:`float`, optional): Longitude of venue. title (:obj:`str`, optional): Name of the venue. @@ -1831,7 +1832,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). phone_number (:obj:`str`, optional): Contact's phone number. first_name (:obj:`str`, optional): Contact's first name. last_name (:obj:`str`, optional): Contact's last name. @@ -1908,8 +1909,7 @@ class Bot(TelegramObject): """Use this method to send a game. Args: - chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat. game_short_name (:obj:`str`): Short name of the game, serves as the unique identifier for the game. Set up your games via `@BotFather `_. disable_notification (:obj:`bool`, optional): Sends the message silently. Users will @@ -1963,7 +1963,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). action(:class:`telegram.ChatAction` | :obj:`str`): Type of action to broadcast. Choose one, depending on what the user is about to receive. For convenience look at the constants in :class:`telegram.ChatAction` @@ -2019,7 +2019,7 @@ class Bot(TelegramObject): either a list of :class:`telegram.InlineQueryResult` instances or :obj:`None` if there are no more results. cache_time (:obj:`int`, optional): The maximum amount of time in seconds that the - result of the inline query may be cached on the server. Defaults to 300. + result of the inline query may be cached on the server. Defaults to ``300``. is_personal (:obj:`bool`, optional): Pass :obj:`True`, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. @@ -2029,7 +2029,7 @@ class Bot(TelegramObject): exceed 64 bytes. switch_pm_text (:obj:`str`, optional): If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the - bot a start message with the parameter switch_pm_parameter. + bot a start message with the parameter ``switch_pm_parameter``. switch_pm_parameter (:obj:`str`, optional): Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. @@ -2163,7 +2163,7 @@ class Bot(TelegramObject): offset (:obj:`int`, optional): Sequential number of the first photo to be returned. By default, all photos are returned. limit (:obj:`int`, optional): Limits the number of photos to be retrieved. Values - between 1-100 are accepted. Defaults to 100. + between 1-100 are accepted. Defaults to ``100``. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -2266,7 +2266,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target group or username - of the target supergroup or channel (in the format @channelusername). + of the target supergroup or channel (in the format ``@channelusername``). user_id (:obj:`int`): Unique identifier of the target user. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of @@ -2287,7 +2287,7 @@ class Bot(TelegramObject): Telegram API. Returns: - :obj:`bool` On success, :obj:`True` is returned. + :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` @@ -2328,7 +2328,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target supergroup or channel (in the format ``@channelusername``). user_id (:obj:`int`): Unique identifier of the target user. only_if_banned (:obj:`bool`, optional): Do nothing if the user is not banned. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as @@ -2369,9 +2369,9 @@ class Bot(TelegramObject): will be displayed to the user as a notification at the top of the chat screen or as an alert. Alternatively, the user can be redirected to the specified Game URL. For this option to - work, you must first create a game for your bot via BotFather and accept the terms. - Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with - a parameter. + work, you must first create a game for your bot via `@BotFather `_ + and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open + your bot with a parameter. Args: callback_query_id (:obj:`str`): Unique identifier for the query to be answered. @@ -2436,7 +2436,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`, optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + (in the format ``@channelusername``) message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not @@ -2507,7 +2507,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`, optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + (in the format ``@channelusername``) message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not @@ -2584,7 +2584,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`, optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel - (in the format @channelusername). + (in the format ``@channelusername``). message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not @@ -2647,7 +2647,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`, optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel - (in the format @channelusername). + (in the format ``@channelusername``). message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not @@ -2708,15 +2708,15 @@ class Bot(TelegramObject): greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an - offset higher than its update_id. The negative offset can be specified to retrieve - updates starting from -offset update from the end of the updates queue. All - previous updates will forgotten. + offset higher than its :attr:`telegram.Update.update_id`. The negative offset can + be specified to retrieve updates starting from -offset update from the end of the + updates queue. All previous updates will forgotten. limit (:obj:`int`, optional): Limits the number of updates to be retrieved. Values - between 1-100 are accepted. Defaults to 100. - timeout (:obj:`int`, optional): Timeout in seconds for long polling. Defaults to 0, + between 1-100 are accepted. Defaults to ``100``. + timeout (:obj:`int`, optional): Timeout in seconds for long polling. Defaults to ``0``, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. - read_latency (:obj:`float`| :obj:`int`, optional): Grace time in seconds for receiving + read_latency (:obj:`float` | :obj:`int`, optional): Grace time in seconds for receiving the reply from server. Will be added to the ``timeout`` value and used as the read timeout from server. Defaults to ``2``. allowed_updates (List[:obj:`str`]), optional): A JSON-serialized list the types of @@ -2805,9 +2805,9 @@ class Bot(TelegramObject): ip_address (:obj:`str`, optional): The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS. max_connections (:obj:`int`, optional): Maximum allowed number of simultaneous HTTPS - connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower - values to limit the load on your bot's server, and higher values to increase your - bot's throughput. + connections to the webhook for update delivery, 1-100. Defaults to ``40``. Use + lower values to limit the load on your bot's server, and higher values to increase + your bot's throughput. allowed_updates (List[:obj:`str`], optional): A JSON-serialized list the types of updates you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. @@ -2826,12 +2826,12 @@ class Bot(TelegramObject): Telegram API. Note: - 1. You will not be able to receive updates using get_updates for as long as an outgoing - webhook is set up. + 1. You will not be able to receive updates using :meth:`get_updates` for long as an + outgoing webhook is set up. 2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work. - 3. Ports currently supported for Webhooks: 443, 80, 88, 8443. + 3. Ports currently supported for Webhooks: ``443``, ``80``, ``88``, ``8443``. If you're having any trouble setting up webhooks, please check out this `guide to Webhooks`_. @@ -2873,10 +2873,10 @@ class Bot(TelegramObject): ) -> bool: """ Use this method to remove webhook integration if you decide to switch back to - getUpdates. Requires no parameters. + :meth:`get_updates()`. Args: - drop_pending_updates(:obj:`bool`, optional): Pass :obj:`True`: to drop all pending + drop_pending_updates (:obj:`bool`, optional): Pass :obj:`True` to drop all pending updates. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of @@ -2885,7 +2885,7 @@ class Bot(TelegramObject): Telegram API. Returns: - :obj:`bool` On success, :obj:`True` is returned. + :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` @@ -2911,7 +2911,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target supergroup or channel (in the format ``@channelusername``). timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -2919,7 +2919,7 @@ class Bot(TelegramObject): Telegram API. Returns: - :obj:`bool` On success, :obj:`True` is returned. + :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` @@ -2944,7 +2944,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target supergroup or channel (in the format ``@channelusername``). timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -2976,7 +2976,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target supergroup or channel (in the format ``@channelusername``). timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -3010,7 +3010,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target supergroup or channel (in the format ``@channelusername``). timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -3042,7 +3042,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target supergroup or channel (in the format ``@channelusername``). user_id (:obj:`int`): Unique identifier of the target user. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of @@ -3131,7 +3131,8 @@ class Bot(TelegramObject): ) -> WebhookInfo: """Use this method to get current webhook status. Requires no parameters. - If the bot is using getUpdates, will return an object with the url field empty. + If the bot is using :meth:`get_updates`, will return an object with the + :attr:`telegram.WebhookInfo.url` field empty. Args: timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as @@ -3224,7 +3225,7 @@ class Bot(TelegramObject): ) -> List[GameHighScore]: """ Use this method to get data for high score tables. Will return the score of the specified - user and several of his neighbors in a game. + user and several of their neighbors in a game. Args: user_id (:obj:`int`): Target user id. @@ -3450,9 +3451,10 @@ class Bot(TelegramObject): api_kwargs: JSONDict = None, ) -> bool: """ - If you sent an invoice requesting a shipping address and the parameter is_flexible was - specified, the Bot API will send an Update with a shipping_query field to the bot. Use - this method to reply to shipping queries. + If you sent an invoice requesting a shipping address and the parameter ``is_flexible`` was + specified, the Bot API will send an :class:`telegram.Update` with a + :attr:`Update.shipping_query` field to the bot. Use this method to reply to shipping + queries. Args: shipping_query_id (:obj:`str`): Unique identifier for the query to be answered. @@ -3518,8 +3520,8 @@ class Bot(TelegramObject): ) -> bool: """ Once the user has confirmed their payment and shipping details, the Bot API sends the final - confirmation in the form of an Update with the field pre_checkout_query. Use this method to - respond to such pre-checkout queries. + confirmation in the form of an :class:`telegram.Update` with the field + :attr:`Update.pre_checkout_query`. Use this method to respond to such pre-checkout queries. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout @@ -3653,7 +3655,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). user_id (:obj:`int`): Unique identifier of the target user. is_anonymous (:obj:`bool`, optional): Pass :obj:`True`, if the administrator's presence in the chat is hidden. @@ -3665,7 +3667,7 @@ class Bot(TelegramObject): .. versionadded:: 13.4 can_manage_voice_chats (:obj:`bool`, optional): Pass :obj:`True`, if the administrator - can manage voice chats, supergroups only. + can manage voice chats. .. versionadded:: 13.4 @@ -3740,7 +3742,7 @@ class Bot(TelegramObject): """ Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the - :attr:`can_restrict_members` admin rights. + :attr:`telegram.ChatMember.can_restrict_members` admin rights. Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username of @@ -3782,7 +3784,7 @@ class Bot(TelegramObject): chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`). user_id (:obj:`int`): Unique identifier of the target administrator. - custom_title (:obj:`str`) New custom title for the administrator; 0-16 characters, + custom_title (:obj:`str`): New custom title for the administrator; 0-16 characters, emoji are not allowed. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of @@ -3819,7 +3821,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -3864,7 +3866,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will expire. For timezone naive :obj:`datetime.datetime` objects, the default timezone of the @@ -3920,7 +3922,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). invite_link (:obj:`str`): The invite link to edit. expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will expire. @@ -3974,7 +3976,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). invite_link (:obj:`str`): The invite link to edit. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of @@ -4010,7 +4012,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). photo (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`): New chat photo. .. versionchanged:: 13.2 @@ -4048,7 +4050,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -4083,7 +4085,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). title (:obj:`str`): New chat title, 1-255 characters. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of @@ -4119,7 +4121,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). description (:obj:`str`): New chat description, 0-255 characters. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of @@ -4152,12 +4154,12 @@ class Bot(TelegramObject): """ Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work - and must have the ``can_pin_messages`` admin right in a supergroup or ``can_edit_messages`` - admin right in a channel. + and must have the :attr:`telegram.ChatMember.can_pin_messages` admin right in a supergroup + or :attr:`telegram.ChatMember.can_edit_messages` admin right in a channel. Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). message_id (:obj:`int`): Identifier of a message to pin. disable_notification (:obj:`bool`, optional): Pass :obj:`True`, if it is not necessary to send a notification to all chat members about the new pinned message. @@ -4196,12 +4198,12 @@ class Bot(TelegramObject): """ Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work - and must have the ``can_pin_messages`` admin right in a supergroup or ``can_edit_messages`` - admin right in a channel. + and must have the :attr:`telegram.ChatMember.can_pin_messages` admin right in a + supergroup or :attr:`telegram.ChatMember.can_edit_messages` admin right in a channel. Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). message_id (:obj:`int`, optional): Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as @@ -4236,12 +4238,12 @@ class Bot(TelegramObject): """ Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this - to work and must have the ``can_pin_messages`` admin right in a supergroup or - ``can_edit_messages`` admin right in a channel. + to work and must have the :attr:`telegram.ChatMember.can_pin_messages` admin right in a + supergroup or :attr:`telegram.ChatMember.can_edit_messages` admin right in a channel. Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -4354,7 +4356,7 @@ class Bot(TelegramObject): """ Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. - You must use exactly one of the fields png_sticker or tgs_sticker. + You must use exactly one of the fields ``png_sticker`` or ``tgs_sticker``. Warning: As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the @@ -4440,9 +4442,9 @@ class Bot(TelegramObject): ) -> bool: """ Use this method to add a new sticker to a set created by the bot. - You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers - can be added to animated sticker sets and only to them. Animated sticker sets can have up - to 50 stickers. Static sticker sets can have up to 120 stickers. + You must use exactly one of the fields ``png_sticker`` or ``tgs_sticker``. Animated + stickers can be added to animated sticker sets and only to them. Animated sticker sets can + have up to 50 stickers. Static sticker sets can have up to 120 stickers. Warning: As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the @@ -4691,8 +4693,8 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). - question (:obj:`str`): Poll question, 1-255 characters. + of the target channel (in the format ``@channelusername``). + question (:obj:`str`): Poll question, 1-300 characters. options (List[:obj:`str`]): List of answer options, 2-10 strings 1-100 characters each. is_anonymous (:obj:`bool`, optional): :obj:`True`, if the poll needs to be anonymous, defaults to :obj:`True`. @@ -4798,7 +4800,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). message_id (:obj:`int`): Identifier of the original message with the poll. reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized object for a new message inline keyboard. @@ -4847,7 +4849,7 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). emoji (:obj:`str`, optional): Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, "🎳", or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and "🎳", values 1-5 for “🏀” and “⚽”, and values 1-64 @@ -5029,9 +5031,9 @@ class Bot(TelegramObject): Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username - of the target channel (in the format @channelusername). + of the target channel (in the format ``@channelusername``). from_chat_id (:obj:`int` | :obj:`str`): Unique identifier for the chat where the - original message was sent (or channel username in the format @channelusername). + original message was sent (or channel username in the format ``@channelusername``). message_id (:obj:`int`): Message identifier in the chat specified in from_chat_id. caption (:obj:`str`, optional): New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept. diff --git a/telegram/chatpermissions.py b/telegram/chatpermissions.py index 061bd251e..fec9d9d1c 100644 --- a/telegram/chatpermissions.py +++ b/telegram/chatpermissions.py @@ -29,7 +29,7 @@ class ChatPermissions(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`can_send_messages`, :attr:`can_send_media_messages`, :attr:`can_send_polls`, :attr:`can_send_other_messages`, :attr:`can_add_web_page_previews`, - :attr:`can_change_info`, :attr:`can_invite_users` and :attr:`can_pin_message` are equal. + :attr:`can_change_info`, :attr:`can_invite_users` and :attr:`can_pin_messages` are equal. Note: Though not stated explicitly in the official docs, Telegram changes not only the diff --git a/telegram/constants.py b/telegram/constants.py index 499a0e5f5..02cb2d25f 100644 --- a/telegram/constants.py +++ b/telegram/constants.py @@ -55,59 +55,60 @@ as attributes of those classes: :class:`telegram.Chat`: Attributes: - CHAT_PRIVATE (:obj:`str`): 'private' - CHAT_GROUP (:obj:`str`): 'group' - CHAT_SUPERGROUP (:obj:`str`): 'supergroup' - CHAT_CHANNEL (:obj:`str`): 'channel' - CHAT_SENDER (:obj:`str`): 'sender'. Only relevant for :attr:`telegram.InlineQuery.chat_type`. + CHAT_PRIVATE (:obj:`str`): ``'private'`` + CHAT_GROUP (:obj:`str`): ``'group'`` + CHAT_SUPERGROUP (:obj:`str`): ``'supergroup'`` + CHAT_CHANNEL (:obj:`str`): ``'channel'`` + CHAT_SENDER (:obj:`str`): ``'sender'``. Only relevant for + :attr:`telegram.InlineQuery.chat_type`. .. versionadded:: 13.5 :class:`telegram.ChatAction`: Attributes: - CHATACTION_FIND_LOCATION (:obj:`str`): 'find_location' - CHATACTION_RECORD_AUDIO (:obj:`str`): 'record_audio' + CHATACTION_FIND_LOCATION (:obj:`str`): ``'find_location'`` + CHATACTION_RECORD_AUDIO (:obj:`str`): ``'record_audio'`` .. deprecated:: 13.5 Deprecated by Telegram. Use :const:`CHATACTION_RECORD_VOICE` instead. - CHATACTION_RECORD_VOICE (:obj:`str`): 'record_voice' + CHATACTION_RECORD_VOICE (:obj:`str`): ``'record_voice'`` .. versionadded:: 13.5 - CHATACTION_RECORD_VIDEO (:obj:`str`): 'record_video' - CHATACTION_RECORD_VIDEO_NOTE (:obj:`str`): 'record_video_note' - CHATACTION_TYPING (:obj:`str`): 'typing' - CHATACTION_UPLOAD_AUDIO (:obj:`str`): 'upload_audio' + CHATACTION_RECORD_VIDEO (:obj:`str`): ``'record_video'`` + CHATACTION_RECORD_VIDEO_NOTE (:obj:`str`): ``'record_video_note'`` + CHATACTION_TYPING (:obj:`str`): ``'typing'`` + CHATACTION_UPLOAD_AUDIO (:obj:`str`): ``'upload_audio'`` .. deprecated:: 13.5 Deprecated by Telegram. Use :const:`CHATACTION_UPLOAD_VOICE` instead. - CHATACTION_UPLOAD_VOICE (:obj:`str`): 'upload_voice' + CHATACTION_UPLOAD_VOICE (:obj:`str`): ``'upload_voice'`` .. versionadded:: 13.5 - CHATACTION_UPLOAD_DOCUMENT (:obj:`str`): 'upload_document' - CHATACTION_UPLOAD_PHOTO (:obj:`str`): 'upload_photo' - CHATACTION_UPLOAD_VIDEO (:obj:`str`): 'upload_video' - CHATACTION_UPLOAD_VIDEO_NOTE (:obj:`str`): 'upload_video_note' + CHATACTION_UPLOAD_DOCUMENT (:obj:`str`): ``'upload_document'`` + CHATACTION_UPLOAD_PHOTO (:obj:`str`): ``'upload_photo'`` + CHATACTION_UPLOAD_VIDEO (:obj:`str`): ``'upload_video'`` + CHATACTION_UPLOAD_VIDEO_NOTE (:obj:`str`): ``'upload_video_note'`` :class:`telegram.ChatMember`: Attributes: - CHATMEMBER_ADMINISTRATOR (:obj:`str`): 'administrator' - CHATMEMBER_CREATOR (:obj:`str`): 'creator' - CHATMEMBER_KICKED (:obj:`str`): 'kicked' - CHATMEMBER_LEFT (:obj:`str`): 'left' - CHATMEMBER_MEMBER (:obj:`str`): 'member' - CHATMEMBER_RESTRICTED (:obj:`str`): 'restricted' + CHATMEMBER_ADMINISTRATOR (:obj:`str`): ``'administrator'`` + CHATMEMBER_CREATOR (:obj:`str`): ``'creator'`` + CHATMEMBER_KICKED (:obj:`str`): ``'kicked'`` + CHATMEMBER_LEFT (:obj:`str`): ``'left'`` + CHATMEMBER_MEMBER (:obj:`str`): ``'member'`` + CHATMEMBER_RESTRICTED (:obj:`str`): ``'restricted'`` :class:`telegram.Dice`: Attributes: - DICE_DICE (:obj:`str`): '🎲' - DICE_DARTS (:obj:`str`): '🎯' - DICE_BASKETBALL (:obj:`str`): '🏀' - DICE_FOOTBALL (:obj:`str`): '⚽' - DICE_SLOT_MACHINE (:obj:`str`): '🎰' - DICE_BOWLING (:obj:`str`): '🎳' + DICE_DICE (:obj:`str`): ``'🎲'`` + DICE_DARTS (:obj:`str`): ``'🎯'`` + DICE_BASKETBALL (:obj:`str`): ``'🏀'`` + DICE_FOOTBALL (:obj:`str`): ``'⚽'`` + DICE_SLOT_MACHINE (:obj:`str`): ``'🎰'`` + DICE_BOWLING (:obj:`str`): ``'🎳'`` .. versionadded:: 13.4 DICE_ALL_EMOJI (List[:obj:`str`]): List of all supported base emoji. @@ -118,45 +119,45 @@ Attributes: :class:`telegram.MessageEntity`: Attributes: - MESSAGEENTITY_MENTION (:obj:`str`): 'mention' - MESSAGEENTITY_HASHTAG (:obj:`str`): 'hashtag' - MESSAGEENTITY_CASHTAG (:obj:`str`): 'cashtag' - MESSAGEENTITY_PHONE_NUMBER (:obj:`str`): 'phone_number' - MESSAGEENTITY_BOT_COMMAND (:obj:`str`): 'bot_command' - MESSAGEENTITY_URL (:obj:`str`): 'url' - MESSAGEENTITY_EMAIL (:obj:`str`): 'email' - MESSAGEENTITY_BOLD (:obj:`str`): 'bold' - MESSAGEENTITY_ITALIC (:obj:`str`): 'italic' - MESSAGEENTITY_CODE (:obj:`str`): 'code' - MESSAGEENTITY_PRE (:obj:`str`): 'pre' - MESSAGEENTITY_TEXT_LINK (:obj:`str`): 'text_link' - MESSAGEENTITY_TEXT_MENTION (:obj:`str`): 'text_mention' - MESSAGEENTITY_UNDERLINE (:obj:`str`): 'underline' - MESSAGEENTITY_STRIKETHROUGH (:obj:`str`): 'strikethrough' + MESSAGEENTITY_MENTION (:obj:`str`): ``'mention'`` + MESSAGEENTITY_HASHTAG (:obj:`str`): ``'hashtag'`` + MESSAGEENTITY_CASHTAG (:obj:`str`): ``'cashtag'`` + MESSAGEENTITY_PHONE_NUMBER (:obj:`str`): ``'phone_number'`` + MESSAGEENTITY_BOT_COMMAND (:obj:`str`): ``'bot_command'`` + MESSAGEENTITY_URL (:obj:`str`): ``'url'`` + MESSAGEENTITY_EMAIL (:obj:`str`): ``'email'`` + MESSAGEENTITY_BOLD (:obj:`str`): ``'bold'`` + MESSAGEENTITY_ITALIC (:obj:`str`): ``'italic'`` + MESSAGEENTITY_CODE (:obj:`str`): ``'code'`` + MESSAGEENTITY_PRE (:obj:`str`): ``'pre'`` + MESSAGEENTITY_TEXT_LINK (:obj:`str`): ``'text_link'`` + MESSAGEENTITY_TEXT_MENTION (:obj:`str`): ``'text_mention'`` + MESSAGEENTITY_UNDERLINE (:obj:`str`): ``'underline'`` + MESSAGEENTITY_STRIKETHROUGH (:obj:`str`): ``'strikethrough'`` MESSAGEENTITY_ALL_TYPES (List[:obj:`str`]): List of all the types of message entity. :class:`telegram.ParseMode`: Attributes: - PARSEMODE_MARKDOWN (:obj:`str`): 'Markdown' - PARSEMODE_MARKDOWN_V2 (:obj:`str`): 'MarkdownV2' - PARSEMODE_HTML (:obj:`str`): 'HTML' + PARSEMODE_MARKDOWN (:obj:`str`): ``'Markdown'`` + PARSEMODE_MARKDOWN_V2 (:obj:`str`): ``'MarkdownV2'`` + PARSEMODE_HTML (:obj:`str`): ``'HTML'`` :class:`telegram.Poll`: Attributes: - POLL_REGULAR (:obj:`str`): 'regular' - POLL_QUIZ (:obj:`str`): 'quiz' + POLL_REGULAR (:obj:`str`): ``'regular'`` + POLL_QUIZ (:obj:`str`): ``'quiz'`` MAX_POLL_QUESTION_LENGTH (:obj:`int`): 300 MAX_POLL_OPTION_LENGTH (:obj:`int`): 100 :class:`telegram.MaskPosition`: Attributes: - STICKER_FOREHEAD (:obj:`str`): 'forehead' - STICKER_EYES (:obj:`str`): 'eyes' - STICKER_MOUTH (:obj:`str`): 'mouth' - STICKER_CHIN (:obj:`str`): 'chin' + STICKER_FOREHEAD (:obj:`str`): ``'forehead'`` + STICKER_EYES (:obj:`str`): ``'eyes'`` + STICKER_MOUTH (:obj:`str`): ``'mouth'`` + STICKER_CHIN (:obj:`str`): ``'chin'`` :class:`telegram.Update`: diff --git a/telegram/ext/commandhandler.py b/telegram/ext/commandhandler.py index 10a40ba4f..0d25b7f61 100644 --- a/telegram/ext/commandhandler.py +++ b/telegram/ext/commandhandler.py @@ -47,16 +47,14 @@ class CommandHandler(Handler[Update]): use ``~Filters.update.edited_message`` in the filter argument. Note: - :class:`telegram.ext.CommandHandler` does *not* handle (edited) channel posts. + * :class:`CommandHandler` does *not* handle (edited) channel posts. + * :attr:`pass_user_data` and :attr:`pass_chat_data` determine whether a :obj:`dict` you + can use to keep any data in will be sent to the :attr:`callback` function. Related to + either the user or the chat that the update was sent in. For each update from the same + user or in the same chat, it will be the same :obj:`dict`. - Note: - :attr:`pass_user_data` and :attr:`pass_chat_data` determine whether a :obj:`dict` you - can use to keep any data in will be sent to the :attr:`callback` function. Related to - either the user or the chat that the update was sent in. For each update from the same user - or in the same chat, it will be the same :obj:`dict`. - - Note that this is DEPRECATED, and you should use context based callbacks. See - https://git.io/fxJuV for more info. + Note that this is DEPRECATED, and you should use context based callbacks. See + https://git.io/fxJuV for more info. Warning: When setting ``run_async`` to :obj:`True`, you cannot rely on adding custom @@ -107,7 +105,7 @@ class CommandHandler(Handler[Update]): Defaults to :obj:`False`. Raises: - ValueError - when command is too long or has illegal chars. + ValueError: when command is too long or has illegal chars. Attributes: command (:class:`telegram.utils.types.SLT[str]`): @@ -248,50 +246,40 @@ class PrefixHandler(CommandHandler): :class:`CallbackContext` named :attr:`CallbackContext.args`. It will contain a list of strings, which is the text following the command split on single or consecutive whitespace characters. - Examples:: + Examples: Single prefix and command: - PrefixHandler('!', 'test', callback) will respond to '!test'. + .. code:: python + + PrefixHandler('!', 'test', callback) # will respond to '!test'. Multiple prefixes, single command: - PrefixHandler(['!', '#'], 'test', callback) will respond to '!test' and - '#test'. + .. code:: python + + PrefixHandler(['!', '#'], 'test', callback) # will respond to '!test' and '#test'. Multiple prefixes and commands: - PrefixHandler(['!', '#'], ['test', 'help`], callback) will respond to '!test', - '#test', '!help' and '#help'. + .. code:: python + + PrefixHandler(['!', '#'], ['test', 'help'], callback) # will respond to '!test', \ +'#test', '!help' and '#help'. By default the handler listens to messages as well as edited messages. To change this behavior - use ~``Filters.update.edited_message``. - - Attributes: - callback (:obj:`callable`): The callback function for this handler. - filters (:class:`telegram.ext.BaseFilter`): Optional. Only allow updates with these - Filters. - pass_args (:obj:`bool`): Determines whether the handler should be passed - ``args``. - pass_update_queue (:obj:`bool`): Determines whether ``update_queue`` will be - passed to the callback function. - pass_job_queue (:obj:`bool`): Determines whether ``job_queue`` will be passed to - the callback function. - pass_user_data (:obj:`bool`): Determines whether ``user_data`` will be passed to - the callback function. - pass_chat_data (:obj:`bool`): Determines whether ``chat_data`` will be passed to - the callback function. - run_async (:obj:`bool`): Determines whether the callback will run asynchronously. + use ``~Filters.update.edited_message``. Note: - :attr:`pass_user_data` and :attr:`pass_chat_data` determine whether a ``dict`` you - can use to keep any data in will be sent to the :attr:`callback` function. Related to - either the user or the chat that the update was sent in. For each update from the same user - or in the same chat, it will be the same ``dict``. + * :class:`PrefixHandler` does *not* handle (edited) channel posts. + * :attr:`pass_user_data` and :attr:`pass_chat_data` determine whether a :obj:`dict` you + can use to keep any data in will be sent to the :attr:`callback` function. Related to + either the user or the chat that the update was sent in. For each update from the same + user or in the same chat, it will be the same :obj:`dict`. - Note that this is DEPRECATED, and you should use context based callbacks. See - https://git.io/fxJuV for more info. + Note that this is DEPRECATED, and you should use context based callbacks. See + https://git.io/fxJuV for more info. Warning: When setting ``run_async`` to :obj:`True`, you cannot rely on adding custom @@ -338,6 +326,22 @@ class PrefixHandler(CommandHandler): run_async (:obj:`bool`): Determines whether the callback will run asynchronously. Defaults to :obj:`False`. + Attributes: + callback (:obj:`callable`): The callback function for this handler. + filters (:class:`telegram.ext.BaseFilter`): Optional. Only allow updates with these + Filters. + pass_args (:obj:`bool`): Determines whether the handler should be passed + ``args``. + pass_update_queue (:obj:`bool`): Determines whether ``update_queue`` will be + passed to the callback function. + pass_job_queue (:obj:`bool`): Determines whether ``job_queue`` will be passed to + the callback function. + pass_user_data (:obj:`bool`): Determines whether ``user_data`` will be passed to + the callback function. + pass_chat_data (:obj:`bool`): Determines whether ``chat_data`` will be passed to + the callback function. + run_async (:obj:`bool`): Determines whether the callback will run asynchronously. + """ def __init__( diff --git a/telegram/ext/updater.py b/telegram/ext/updater.py index f9b6f6d21..163f0f18d 100644 --- a/telegram/ext/updater.py +++ b/telegram/ext/updater.py @@ -254,7 +254,7 @@ class Updater: Args: poll_interval (:obj:`float`, optional): Time to wait between polling updates from - Telegram in seconds. Default is 0.0. + Telegram in seconds. Default is ``0.0``. timeout (:obj:`float`, optional): Passed to :meth:`telegram.Bot.get_updates`. drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on Telegram servers before actually starting to poll. Default is :obj:`False`. @@ -275,7 +275,7 @@ class Updater: :meth:`telegram.Bot.get_updates`. read_latency (:obj:`float` | :obj:`int`, optional): Grace time in seconds for receiving the reply from server. Will be added to the ``timeout`` value and used as the read - timeout from server (Default: 2). + timeout from server (Default: ``2``). Returns: :obj:`Queue`: The update queue that can be filled from the main thread. @@ -339,12 +339,16 @@ class Updater: ip_address: str = None, ) -> Optional[Queue]: """ - Starts a small http server to listen for updates via webhook. If cert - and key are not provided, the webhook will be started directly on + Starts a small http server to listen for updates via webhook. If :attr:`cert` + and :attr:`key` are not provided, the webhook will be started directly on http://listen:port/url_path, so SSL can be handled by another application. Else, the webhook will be started on https://listen:port/url_path. Also calls :meth:`telegram.Bot.set_webhook` as required. + .. versionchanged:: 13.4 + :meth:`start_webhook` now *always* calls :meth:`telegram.Bot.set_webhook`, so pass + ``webhook_url`` instead of calling ``updater.bot.set_webhook(webhook_url)`` manually. + Note: Due to an incompatibility of the Tornado library PTB uses for the webhook with Python 3.8+ on Windows machines, PTB will attempt to set the event loop to @@ -742,8 +746,8 @@ class Updater: Args: stop_signals (:obj:`list` | :obj:`tuple`): List containing signals from the signal - module that should be subscribed to. Updater.stop() will be called on receiving one - of those signals. Defaults to (``SIGINT``, ``SIGTERM``, ``SIGABRT``). + module that should be subscribed to. :meth:`Updater.stop()` will be called on + receiving one of those signals. Defaults to (``SIGINT``, ``SIGTERM``, ``SIGABRT``). """ for sig in stop_signals: diff --git a/telegram/inline/inlinequeryresult.py b/telegram/inline/inlinequeryresult.py index cb7c38acc..929b44b4c 100644 --- a/telegram/inline/inlinequeryresult.py +++ b/telegram/inline/inlinequeryresult.py @@ -33,7 +33,7 @@ class InlineQueryResult(TelegramObject): Note: All URLs passed in inline query results will be available to end users and therefore must - be assumed to be public. + be assumed to be *public*. Args: type (:obj:`str`): Type of the result. diff --git a/telegram/passport/passportelementerrors.py b/telegram/passport/passportelementerrors.py index c37bb12df..610f6cbd5 100644 --- a/telegram/passport/passportelementerrors.py +++ b/telegram/passport/passportelementerrors.py @@ -27,8 +27,11 @@ from telegram import TelegramObject class PassportElementError(TelegramObject): """Baseclass for the PassportElementError* classes. + This object represents an error in the Telegram Passport element which was submitted that + should be resolved by the user. + Objects of this class are comparable in terms of equality. Two objects of this class are - considered equal, if their :attr:`source` and :attr:`type` are equal. + considered equal, if their :attr:`source` and :attr:`type` are equal. Args: source (:obj:`str`): Error source. @@ -58,12 +61,12 @@ class PassportElementErrorDataField(PassportElementError): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`source`, :attr:`type`, :attr:`field_name`, :attr:`data_hash` - and :attr:`message` are equal. + and :attr:`message` are equal. Args: type (:obj:`str`): The section of the user's Telegram Passport which has the error, one of - "personal_details", "passport", "driver_license", "identity_card", "internal_passport", - "address". + ``"personal_details"``, ``"passport"``, ``"driver_license"``, ``"identity_card"``, + ``"internal_passport"``, ``"address"``. field_name (:obj:`str`): Name of the data field which has the error. data_hash (:obj:`str`): Base64-encoded data hash. message (:obj:`str`): Error message. @@ -71,8 +74,8 @@ class PassportElementErrorDataField(PassportElementError): Attributes: type (:obj:`str`): The section of the user's Telegram Passport which has the error, one of - "personal_details", "passport", "driver_license", "identity_card", "internal_passport", - "address". + ``"personal_details"``, ``"passport"``, ``"driver_license"``, ``"identity_card"``, + ``"internal_passport"``, ``"address"``. field_name (:obj:`str`): Name of the data field which has the error. data_hash (:obj:`str`): Base64-encoded data hash. message (:obj:`str`): Error message. @@ -94,21 +97,21 @@ class PassportElementErrorFile(PassportElementError): the document scan changes. Objects of this class are comparable in terms of equality. Two objects of this class are - considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, :attr:`data_hash` - and :attr:`message` are equal. + considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, and + :attr:`message` are equal. Args: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "utility_bill", "bank_statement", "rental_agreement", "passport_registration", - "temporary_registration". + ``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``, + ``"passport_registration"``, ``"temporary_registration"``. file_hash (:obj:`str`): Base64-encoded file hash. message (:obj:`str`): Error message. **kwargs (:obj:`dict`): Arbitrary keyword arguments. Attributes: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "utility_bill", "bank_statement", "rental_agreement", "passport_registration", - "temporary_registration". + ``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``, + ``"passport_registration"``, ``"temporary_registration"``. file_hash (:obj:`str`): Base64-encoded file hash. message (:obj:`str`): Error message. @@ -124,25 +127,25 @@ class PassportElementErrorFile(PassportElementError): class PassportElementErrorFiles(PassportElementError): """ - Represents an issue with a list of scans. The error is considered resolved when the file with - the document scan changes. + Represents an issue with a list of scans. The error is considered resolved when the list of + files with the document scans changes. Objects of this class are comparable in terms of equality. Two objects of this class are - considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hashes`, :attr:`data_hash` - and :attr:`message` are equal. + considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hashes`, and + :attr:`message` are equal. Args: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "utility_bill", "bank_statement", "rental_agreement", "passport_registration", - "temporary_registration". + ``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``, + ``"passport_registration"``, ``"temporary_registration"``. file_hashes (List[:obj:`str`]): List of base64-encoded file hashes. message (:obj:`str`): Error message. **kwargs (:obj:`dict`): Arbitrary keyword arguments. Attributes: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "utility_bill", "bank_statement", "rental_agreement", "passport_registration", - "temporary_registration". + ``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``, + ``"passport_registration"``, ``"temporary_registration"``. file_hashes (List[:obj:`str`]): List of base64-encoded file hashes. message (:obj:`str`): Error message. @@ -162,12 +165,12 @@ class PassportElementErrorFrontSide(PassportElementError): the file with the front side of the document changes. Objects of this class are comparable in terms of equality. Two objects of this class are - considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, :attr:`data_hash` - and :attr:`message` are equal. + considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, and + :attr:`message` are equal. Args: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "passport", "driver_license", "identity_card", "internal_passport". + ``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``. file_hash (:obj:`str`): Base64-encoded hash of the file with the front side of the document. message (:obj:`str`): Error message. @@ -175,7 +178,7 @@ class PassportElementErrorFrontSide(PassportElementError): Attributes: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "passport", "driver_license", "identity_card", "internal_passport". + ``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``. file_hash (:obj:`str`): Base64-encoded hash of the file with the front side of the document. message (:obj:`str`): Error message. @@ -192,16 +195,16 @@ class PassportElementErrorFrontSide(PassportElementError): class PassportElementErrorReverseSide(PassportElementError): """ - Represents an issue with the front side of a document. The error is considered resolved when + Represents an issue with the reverse side of a document. The error is considered resolved when the file with the reverse side of the document changes. Objects of this class are comparable in terms of equality. Two objects of this class are - considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, :attr:`data_hash` - and :attr:`message` are equal. + considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, and + :attr:`message` are equal. Args: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "driver_license", "identity_card". + ``"driver_license"``, ``"identity_card"``. file_hash (:obj:`str`): Base64-encoded hash of the file with the reverse side of the document. message (:obj:`str`): Error message. @@ -209,7 +212,7 @@ class PassportElementErrorReverseSide(PassportElementError): Attributes: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "passport", "driver_license", "identity_card", "internal_passport". + ``"driver_license"``, ``"identity_card"``. file_hash (:obj:`str`): Base64-encoded hash of the file with the reverse side of the document. message (:obj:`str`): Error message. @@ -230,19 +233,19 @@ class PassportElementErrorSelfie(PassportElementError): the file with the selfie changes. Objects of this class are comparable in terms of equality. Two objects of this class are - considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, :attr:`data_hash` - and :attr:`message` are equal. + considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, and + :attr:`message` are equal. Args: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "passport", "driver_license", "identity_card", "internal_passport". + ``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``. file_hash (:obj:`str`): Base64-encoded hash of the file with the selfie. message (:obj:`str`): Error message. **kwargs (:obj:`dict`): Arbitrary keyword arguments. Attributes: type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of - "passport", "driver_license", "identity_card", "internal_passport". + ``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``. file_hash (:obj:`str`): Base64-encoded hash of the file with the selfie. message (:obj:`str`): Error message. @@ -262,23 +265,23 @@ class PassportElementErrorTranslationFile(PassportElementError): The error is considered resolved when the file changes. Objects of this class are comparable in terms of equality. Two objects of this class are - considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, :attr:`data_hash` - and :attr:`message` are equal. + considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hash`, and + :attr:`message` are equal. Args: type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue, - one of "passport", "driver_license", "identity_card", "internal_passport", - "utility_bill", "bank_statement", "rental_agreement", "passport_registration", - "temporary_registration". + one of ``"passport"``, ``"driver_license"``, ``"identity_card"``, + ``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``, + ``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``. file_hash (:obj:`str`): Base64-encoded hash of the file. message (:obj:`str`): Error message. **kwargs (:obj:`dict`): Arbitrary keyword arguments. Attributes: type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue, - one of "passport", "driver_license", "identity_card", "internal_passport", - "utility_bill", "bank_statement", "rental_agreement", "passport_registration", - "temporary_registration". + one of ``"passport"``, ``"driver_license"``, ``"identity_card"``, + ``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``, + ``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``. file_hash (:obj:`str`): Base64-encoded hash of the file. message (:obj:`str`): Error message. @@ -295,26 +298,26 @@ class PassportElementErrorTranslationFile(PassportElementError): class PassportElementErrorTranslationFiles(PassportElementError): """ Represents an issue with the translated version of a document. The error is considered - resolved when a file with the document translation change. + resolved when a file with the document translation changes. Objects of this class are comparable in terms of equality. Two objects of this class are - considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hashes`, :attr:`data_hash` - and :attr:`message` are equal. + considered equal, if their :attr:`source`, :attr:`type`, :attr:`file_hashes`, and + :attr:`message` are equal. Args: type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue, - one of "passport", "driver_license", "identity_card", "internal_passport", - "utility_bill", "bank_statement", "rental_agreement", "passport_registration", - "temporary_registration" + one of ``"passport"``, ``"driver_license"``, ``"identity_card"``, + ``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``, + ``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``. file_hashes (List[:obj:`str`]): List of base64-encoded file hashes. message (:obj:`str`): Error message. **kwargs (:obj:`dict`): Arbitrary keyword arguments. Attributes: type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue, - one of "passport", "driver_license", "identity_card", "internal_passport", - "utility_bill", "bank_statement", "rental_agreement", "passport_registration", - "temporary_registration" + one of ``"passport"``, ``"driver_license"``, ``"identity_card"``, + ``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``, + ``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``. file_hashes (List[:obj:`str`]): List of base64-encoded file hashes. message (:obj:`str`): Error message. @@ -335,7 +338,7 @@ class PassportElementErrorUnspecified(PassportElementError): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`source`, :attr:`type`, :attr:`element_hash`, - :attr:`data_hash` and :attr:`message` are equal. + and :attr:`message` are equal. Args: type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue. diff --git a/telegram/replymarkup.py b/telegram/replymarkup.py index a7378c0ca..8c77b1e40 100644 --- a/telegram/replymarkup.py +++ b/telegram/replymarkup.py @@ -24,7 +24,8 @@ from telegram import TelegramObject class ReplyMarkup(TelegramObject): """Base class for Telegram ReplyMarkup Objects. - See :class:`telegram.ReplyKeyboardMarkup` and :class:`telegram.InlineKeyboardMarkup` for + See :class:`telegram.InlineKeyboardMarkup`, :class:`telegram.ReplyKeyboardMarkup`, + :class:`telegram.ReplyKeyboardRemove` and :class:`telegram.ForceReply` for detailed use. """ diff --git a/telegram/utils/request.py b/telegram/utils/request.py index f34c4f653..b71e57de8 100644 --- a/telegram/utils/request.py +++ b/telegram/utils/request.py @@ -93,20 +93,21 @@ USER_AGENT = 'Python Telegram Bot (https://github.com/python-telegram-bot/python class Request: """ Helper class for python-telegram-bot which provides methods to perform POST & GET towards - telegram servers. + Telegram servers. Args: - con_pool_size (int): Number of connections to keep in the connection pool. - proxy_url (str): The URL to the proxy server. For example: `http://127.0.0.1:3128`. - urllib3_proxy_kwargs (dict): Arbitrary arguments passed as-is to `urllib3.ProxyManager`. - This value will be ignored if proxy_url is not set. - connect_timeout (int|float): The maximum amount of time (in seconds) to wait for a - connection attempt to a server to succeed. None will set an infinite timeout for - connection attempts. (default: 5.) - read_timeout (int|float): The maximum amount of time (in seconds) to wait between - consecutive read operations for a response from the server. None will set an infinite - timeout. This value is usually overridden by the various ``telegram.Bot`` methods. - (default: 5.) + con_pool_size (:obj:`int`): Number of connections to keep in the connection pool. + proxy_url (:obj:`str`): The URL to the proxy server. For example: `http://127.0.0.1:3128`. + urllib3_proxy_kwargs (:obj:`dict`): Arbitrary arguments passed as-is to + :obj:`urllib3.ProxyManager`. This value will be ignored if :attr:`proxy_url` is not + set. + connect_timeout (:obj:`int` | :obj:`float`): The maximum amount of time (in seconds) to + wait for a connection attempt to a server to succeed. :obj:`None` will set an + infinite timeout for connection attempts. Defaults to ``5.0``. + read_timeout (:obj:`int` | :obj:`float`): The maximum amount of time (in seconds) to wait + between consecutive read operations for a response from the server. :obj:`None` will + set an infinite timeout. This value is usually overridden by the various + :class:`telegram.Bot` methods. Defaults to ``5.0``. """ @@ -231,7 +232,7 @@ class Request: Args: args: unnamed arguments, passed to urllib3 request. - kwargs: keyword arguments, passed tp urllib3 request. + kwargs: keyword arguments, passed to urllib3 request. Returns: bytes: A non-parsed JSON text. @@ -288,7 +289,7 @@ class Request: Args: url (:obj:`str`): The web location we want to retrieve. - data (dict[str, str|int], optional): A dict of key/value pairs. + data (Dict[:obj:`str`, :obj:`str` | :obj:`int`], optional): A dict of key/value pairs. timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool). @@ -376,10 +377,10 @@ class Request: """Download a file by its URL. Args: - url (str): The web location we want to retrieve. - timeout (:obj:`int` | :obj:`float`): If this value is specified, use it as the read - timeout from the server (instead of the one specified during creation of the - connection pool). + url (:obj:`str`): The web location we want to retrieve. + timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as + the read timeout from the server (instead of the one specified during creation of + the connection pool). filename (:obj:`str`): The filename within the path to download the file. """ diff --git a/telegram/utils/webhookhandler.py b/telegram/utils/webhookhandler.py index 4384f0b2b..25ccc053d 100644 --- a/telegram/utils/webhookhandler.py +++ b/telegram/utils/webhookhandler.py @@ -16,8 +16,8 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. -"""This module contains the :class:`telegram.ext.utils.promise.Promise` class for backwards -compatibility.""" +"""This module contains the :class:`telegram.ext.utils.webhookhandler.WebhookHandler` class for +backwards compatibility.""" import warnings import telegram.ext.utils.webhookhandler as webhook_handler diff --git a/telegram/webhookinfo.py b/telegram/webhookinfo.py index 03ef130dd..64c7082bf 100644 --- a/telegram/webhookinfo.py +++ b/telegram/webhookinfo.py @@ -46,7 +46,7 @@ class WebhookInfo(TelegramObject): max_connections (:obj:`int`, optional): Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery. allowed_updates (List[:obj:`str`], optional): A list of update types the bot is subscribed - to. Defaults to all update types. + to. Defaults to all update types, except :attr:`telegram.Update.chat_member`. Attributes: url (:obj:`str`): Webhook URL. @@ -58,7 +58,7 @@ class WebhookInfo(TelegramObject): max_connections (:obj:`int`): Optional. Maximum allowed number of simultaneous HTTPS connections. allowed_updates (List[:obj:`str`]): Optional. A list of update types the bot is subscribed - to. + to. Defaults to all update types, except :attr:`telegram.Update.chat_member`. """