diff --git a/README.rst b/README.rst index 44cbe11f12e..9434eae5a65 100644 --- a/README.rst +++ b/README.rst @@ -182,7 +182,7 @@ Resources - The `package documentation `_ is the technical reference for ``python-telegram-bot``. It contains descriptions of all available classes, modules, methods and arguments as well as the `changelog `_. - The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot`` and other useful resources that go beyond the technical documentation. -- Our `examples section `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. +- Our `examples section `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there. The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it. - The `official Telegram Bot API documentation `_ is of course always worth a read. diff --git a/docs/auxil/api_docs.py b/docs/auxil/api_docs.py new file mode 100644 index 00000000000..e878cd0d1a0 --- /dev/null +++ b/docs/auxil/api_docs.py @@ -0,0 +1,459 @@ +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2026 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +"""Generate PTB's API reference from its public exports. + +Sphinx discovers documents from physical source files before it reads their toctrees. Autosummary +can create those files, but normally needs a maintained RST list of objects. This extension instead +collects objects from PTB's ``__all__`` exports during ``builder-inited`` and writes the required +sources before discovery. During ``source-read``, it adds the current navigation in memory, so RST +files never contain generated class lists. + +Maintained API sources live in module-shaped directories for readability. Small generated wrappers +preserve the historic dotted document names and URLs. Generated files remain on disk, and are only +rewritten when their content changes, so Sphinx's normal mtime cache remains effective. + +Relevant Sphinx documentation: + +* Autosummary: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html +* Build events: https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html +""" + +import tempfile +from collections.abc import Mapping, Sequence +from pathlib import Path +from types import ModuleType +from typing import Final, NamedTuple + +from sphinx.application import Sphinx +from sphinx.errors import ExtensionError +from sphinx.ext.autosummary.generate import generate_autosummary_docs +from sphinx.util.typing import ExtensionMetadata + +import telegram +import telegram.ext +import telegram.request + + +class ApiCategory(NamedTuple): + """Describe one topic page and the internal modules whose objects belong on it.""" + + title: str + module_prefixes: tuple[str, ...] + + +class MaintainedFragment(NamedTuple): + """Connect a nested maintained source to its generated dotted-name wrapper.""" + + wrapper_path: Path + relative_path: Path + + +GENERATED_MARKER: Final[str] = ".. Autogenerated page: True" +MAINTAINED_MARKER: Final[str] = ".. Autogenerated page: False" +API_FRAGMENT_DIRECTORIES: Final[tuple[str, ...]] = ("telegram", "telegram_auxil") +API_MODULES: Final[tuple[ModuleType, ...]] = (telegram, telegram.ext, telegram.request) + +# The key is the Sphinx document name. The value supplies its title and the internal module +# prefixes used to recognize its public objects; new objects in those modules need no docs edit. +API_CATEGORIES: Final[dict[str, ApiCategory]] = { + "telegram.stickers-tree": ApiCategory( + title="Stickers", + module_prefixes=("telegram._files.inputsticker", "telegram._files.sticker"), + ), + "telegram.inline-tree": ApiCategory( + title="Inline Mode", + module_prefixes=( + "telegram._choseninlineresult", + "telegram._inline.inlinequery", + "telegram._inline.input", + "telegram._inline.preparedinlinemessage", + ), + ), + "telegram.payments-tree": ApiCategory( + title="Payments", module_prefixes=("telegram._payment.",) + ), + "telegram.games-tree": ApiCategory(title="Games", module_prefixes=("telegram._games.",)), + "telegram.passport-tree": ApiCategory( + title="Passport", module_prefixes=("telegram._passport.",) + ), + "telegram.ext.handlers-tree": ApiCategory( + title="Handlers", + module_prefixes=("telegram.ext._handlers.", "telegram.ext.filters"), + ), + "telegram.ext.persistence-tree": ApiCategory( + title="Persistence", + module_prefixes=( + "telegram.ext._basepersistence", + "telegram.ext._dictpersistence", + "telegram.ext._picklepersistence", + ), + ), + "telegram.ext.acd-tree": ApiCategory( + title="Arbitrary Callback Data", + module_prefixes=("telegram.ext._callbackdatacache",), + ), + "telegram.ext.rate-limiting-tree": ApiCategory( + title="Rate Limiting", + module_prefixes=("telegram.ext._aioratelimiter", "telegram.ext._baseratelimiter"), + ), +} + + +def _build_api_objects() -> dict[str, str]: + """Map every public import name to the internal module that defines its object. + + ``__all__`` is PTB's source of truth for supported imports. The defining module is retained + only to assign each public name to the appropriate topic page without maintaining class lists. + """ + api_objects: dict[str, str] = {} + + # Read the three supported public namespaces and ignore private version metadata. + for api_module in API_MODULES: + for export_name in api_module.__all__: + if export_name.startswith("_"): + continue + + exported_object: object = getattr(api_module, export_name) + defining_module: str = getattr( + exported_object, "__module__", getattr(exported_object, "__name__", "") + ) + public_name: str = f"{api_module.__name__}.{export_name}" + api_objects[public_name] = defining_module + + # Stable case-insensitive ordering makes every generated menu deterministic. + ordered_items: list[tuple[str, str]] = sorted( + api_objects.items(), key=lambda item: item[0].casefold() + ) + return dict(ordered_items) + + +def _build_api_trees(api_objects: Mapping[str, str]) -> dict[str, tuple[str, ...]]: + """Build the navigation trees from topic membership and package fallbacks. + + Topic pages claim their objects first. Everything left over is placed in Available Types, + ``telegram.ext``, ``telegram.request``, or Auxiliary Modules, preventing duplicate entries. + """ + api_trees: dict[str, tuple[str, ...]] = {} + + # This set prevents an object claimed by a topic page from also appearing in a fallback tree. + categorized_objects: set[str] = set() + telegram_category_pages: list[str] = [] + ext_category_pages: list[str] = [] + + # Match public objects to topic pages through their internal module boundaries. + for docname, category in API_CATEGORIES.items(): + category_objects: list[str] = [ + object_name + for object_name, defining_module in api_objects.items() + if defining_module.startswith(category.module_prefixes) + ] + api_trees[docname] = tuple(category_objects) + categorized_objects.update(category_objects) + + if docname.startswith("telegram.ext."): + ext_category_pages.append(docname) + else: + telegram_category_pages.append(docname) + + # These lists form the general package sections after specialized topics have been removed. + available_types: list[str] = [] # Top-level ``telegram`` classes except Bot. + ext_objects: list[str] = [] # Ungrouped ``telegram.ext`` exports. + request_objects: list[str] = [] # Public request implementations. + auxiliary_objects: list[str] = [] # Top-level modules and helper functions. + + for object_name in api_objects: + if object_name.startswith("telegram.ext."): + if object_name not in categorized_objects: + ext_objects.append(object_name) + continue + + if object_name.startswith("telegram.request."): + request_objects.append(object_name) + continue + + short_name: str = object_name.rpartition(".")[2] + if short_name[:1].isupper(): + if object_name != "telegram.Bot" and object_name not in categorized_objects: + available_types.append(object_name) + else: + auxiliary_objects.append(object_name) + + # Package trees contain their ordinary entries followed by generated topic pages. + api_trees["telegram"] = ("telegram.Bot", "telegram.at-tree", *telegram_category_pages) + api_trees["telegram.at-tree"] = tuple(available_types) + api_trees["telegram.ext"] = (*ext_objects, *ext_category_pages) + api_trees["telegram.request"] = tuple(request_objects) + api_trees["telegram_auxil"] = tuple(auxiliary_objects) + return api_trees + + +def _build_api_tree_dependencies() -> tuple[Path, ...]: + """Return files whose changes must invalidate an injected navigation tree. + + The generated toctree text is not present in the physical RST file, so Sphinx cannot infer + these dependencies itself. Tracking the extension and public ``__init__`` files fixes that. + """ + dependencies: list[Path] = [ + Path(api_module.__file__) for api_module in API_MODULES if api_module.__file__ is not None + ] + [Path(__file__)] + return tuple(dependencies) + + +API_OBJECTS: Final[dict[str, str]] = _build_api_objects() +API_TREES: Final[dict[str, tuple[str, ...]]] = _build_api_trees(API_OBJECTS) +API_TREE_DEPENDENCIES: Final[tuple[Path, ...]] = _build_api_tree_dependencies() + + +def _has_marker(path: Path, marker: str) -> bool: + """Return whether the first line marks a page as generated or maintained. + + Ownership markers let cleanup delete obsolete generated files while protecting every file that + a maintainer may edit. + """ + if not path.is_file(): + return False + + # Sphinx defaults to utf-8-sig, so autosummary output may begin with a byte-order mark. + with path.open(encoding="utf-8-sig") as file: + first_line: str = file.readline().rstrip() + return first_line == marker + + +def _write_generated(path: Path, content: str) -> None: + """Safely write one generated page without defeating Sphinx's mtime cache. + + An existing maintained page is always an error. Identical generated content is left untouched, + so a repeated build does not make Sphinx parse the page again. + """ + generated_content: str = f"{GENERATED_MARKER}\n\n{content.rstrip()}\n" + + # Don't overwrite manually written pages: + if path.exists() and not _has_marker(path, GENERATED_MARKER): + raise ExtensionError(f"Refusing to overwrite maintained documentation page: {path}") + + # Preserve the existing mtime unless the generated source actually changed. + if not path.exists() or path.read_text(encoding="utf-8") != generated_content: + path.write_text(generated_content, encoding="utf-8") + + +def _toctree(entries: Sequence[str]) -> str: + """Render navigation text that ``source-read`` can append before RST parsing. + + Entries are lower-cased because the compatibility sources and their historic document names + are lower-case, even though their public Python names retain normal capitalization. + """ + lines: list[str] = [".. toctree::", " :titlesonly:", ""] + lines.extend(f" {entry.lower()}" for entry in entries) + return "\n".join(lines) + + +def _configure_object_targets(app: Sphinx, source_dir: Path) -> dict[str, Path]: + """Configure autosummary's filenames and return each object's physical source path. + + Autosummary normally derives filenames from case-sensitive Python names. Explicit mappings keep + URLs such as ``telegram.chatmember.html`` while still documenting ``telegram.ChatMember``. + """ + object_targets: dict[str, Path] = {} + filename_map: dict[str, str] = dict(app.config.autosummary_filename_map) + + # Both mappings use the same dotted, lower-case document name. + for object_name in API_OBJECTS: + filename: str = object_name.lower() + object_targets[object_name] = source_dir / f"{filename}.rst" + filename_map[object_name] = filename + + app.config.autosummary_filename_map = filename_map + return object_targets + + +def _discover_maintained_fragments(source_dir: Path) -> dict[str, MaintainedFragment]: + """Find maintained sources and describe the dotted wrappers they require. + + Devs work in directories such as ``telegram/ext``. Those directories are excluded from + Sphinx discovery; generated root-level wrappers include them under the historic dotted names. + Every discovered source must explicitly carry the False marker before it can be included. + """ + fragments: dict[str, MaintainedFragment] = {} + unmarked_fragments: list[Path] = [] + + # Scan only the module-shaped directories owned by this extension. + for directory in API_FRAGMENT_DIRECTORIES: + directory_path: Path = source_dir / directory + fragment_paths: list[Path] = sorted(directory_path.rglob("*.rst")) + + for fragment_path in fragment_paths: + if not _has_marker(fragment_path, MAINTAINED_MARKER): + unmarked_fragments.append(fragment_path) + + relative_path: Path = fragment_path.relative_to(source_dir) + docname_parts: tuple[str, ...] = relative_path.with_suffix("").parts + if docname_parts[-1] == "index": + docname_parts = docname_parts[:-1] + + docname: str = ".".join(docname_parts) + wrapper_path: Path = source_dir / f"{docname}.rst" + fragments[docname] = MaintainedFragment(wrapper_path, relative_path) + + # Failing once with every offending path makes ownership errors straightforward to repair. + if unmarked_fragments: + formatted_paths: str = "\n".join(f"* {path}" for path in unmarked_fragments) + raise ExtensionError( + f"Maintained documentation pages need the False marker:\n{formatted_paths}" + ) + + return fragments + + +def _synchronize_compatibility_pages( + source_dir: Path, + object_targets: Mapping[str, Path], + fragments: Mapping[str, MaintainedFragment], +) -> None: + """Synchronize generated wrappers and topic shells before Sphinx scans the source tree. + + Wrapper pages expose nested maintained files under dotted names. Topic shells provide physical + documents for navigation injected later. Obsolete generated pages are removed only when their + marker proves that this extension owns them. + """ + # Build the complete set of generated paths that are still valid in this run. + expected_targets: set[Path] = set(object_targets.values()) + expected_targets.update(fragment.wrapper_path for fragment in fragments.values()) + expected_targets.add(source_dir / "telegram.at-tree.rst") + expected_targets.update(source_dir / f"{docname}.rst" for docname in API_CATEGORIES) + + # Remove pages for exports or maintained fragments that no longer exist. + for generated_path in source_dir.glob("*.rst"): + if generated_path not in expected_targets and _has_marker( + generated_path, GENERATED_MARKER + ): + generated_path.unlink() + + # Each nested maintained source receives a tiny include wrapper with its historic docname. + for fragment in fragments.values(): + include_directive: str = f".. include:: {fragment.relative_path.as_posix()}" + _write_generated(fragment.wrapper_path, include_directive) + + # Topic documents need only a heading; their object lists are injected during source-read. + _write_generated(source_dir / "telegram.at-tree.rst", "Available Types\n---------------") + for docname, category in API_CATEGORIES.items(): + label: str = docname.rpartition(".")[2] + heading: str = "-" * len(category.title) + page_content: str = f".. _{label}:\n\n{category.title}\n{heading}" + _write_generated(source_dir / f"{docname}.rst", page_content) + + +def _generate_object_pages( + app: Sphinx, + source_dir: Path, + object_targets: Mapping[str, Path], + fragments: Mapping[str, MaintainedFragment], +) -> None: + """Ask autosummary to create physical pages for objects without maintained overrides. + + Sphinx requires physical sources for individual class URLs. A temporary autosummary directive + supplies the generated object list without committing that list to RST. The resulting pages + remain in ``source_dir`` and are reused by later builds when their content is unchanged. + """ + maintained_targets: set[Path] = {fragment.wrapper_path for fragment in fragments.values()} + generated_objects: list[str] = [] + conflicting_targets: list[Path] = [] + + # A maintained fragment replaces the default template; any other unmarked collision is unsafe. + for object_name, target_path in object_targets.items(): + if target_path in maintained_targets: + continue + + generated_objects.append(object_name) + if target_path.exists() and not _has_marker(target_path, GENERATED_MARKER): + conflicting_targets.append(target_path) + + if conflicting_targets: + formatted_paths: str = "\n".join(f"* {path}" for path in conflicting_targets) + raise ExtensionError( + f"Refusing to overwrite maintained API documentation pages:\n{formatted_paths}" + ) + + # Autosummary reads this directive exactly as if it lived in a maintained RST document. + manifest_lines: list[str] = [ + ".. autosummary::", + " :toctree:", + " :template: ptb-object.rst", + " :signatures: none", + "", + ] + manifest_lines.extend(f" {object_name}" for object_name in generated_objects) + manifest_content: str = "\n".join(manifest_lines) + + # The manifest is merely input to autosummary; only its generated object pages must persist. + with tempfile.TemporaryDirectory(prefix="ptb-api-docs-") as temporary_directory: + manifest_path: Path = Path(temporary_directory) / "api.rst" + manifest_path.write_text(manifest_content, encoding="utf-8") + generate_autosummary_docs( + [str(manifest_path)], + output_dir=source_dir, + app=app, + overwrite=True, + encoding=app.config.source_encoding, + ) + + +def _generate_api_pages(app: Sphinx) -> None: + """Handle ``builder-inited`` before Sphinx discovers source documents. + + The builder and configuration are ready at this point, but the environment has not scanned the + source directory. Creating and removing generated files here lets normal Sphinx discovery and + incremental-build logic handle them like ordinary RST sources. + """ + source_dir: Path = Path(app.srcdir) + + # Resolve every source path first, then synchronize wrappers and ordinary object pages. + object_targets: dict[str, Path] = _configure_object_targets(app, source_dir) + fragments: dict[str, MaintainedFragment] = _discover_maintained_fragments(source_dir) + _synchronize_compatibility_pages(source_dir, object_targets, fragments) + _generate_object_pages(app, source_dir, object_targets, fragments) + + +def _inject_api_tree(app: Sphinx, docname: str, source: list[str]) -> None: + """Handle ``source-read`` by appending generated navigation before RST parsing. + + Sphinx passes source text in a one-item list so event handlers can replace it. The injected + tree remains absent from disk, while explicit dependencies ensure export changes invalidate + the page. + """ + entries: tuple[str, ...] | None = API_TREES.get(docname) + if not entries: + return + + # Physical RST mtimes cannot represent changes to text generated from Python exports. + for dependency in API_TREE_DEPENDENCIES: + app.env.note_dependency(dependency) + + # Replacing the list item changes the text Sphinx will parse without modifying the source file. + source[0] = f"{source[0].rstrip()}\n\n{_toctree(entries)}\n" + + +def setup(app: Sphinx) -> ExtensionMetadata: + """Register page generation before discovery and tree injection before source parsing.""" + # Priority 400 runs before autosummary's builder-inited handler at the default priority 500. + app.connect("builder-inited", _generate_api_pages, priority=400) + app.connect("source-read", _inject_api_tree) + return { + "version": "1.0", + "parallel_read_safe": True, + "parallel_write_safe": True, + } diff --git a/docs/source/_templates/ptb-object.rst b/docs/source/_templates/ptb-object.rst new file mode 100644 index 00000000000..1cd227e1364 --- /dev/null +++ b/docs/source/_templates/ptb-object.rst @@ -0,0 +1,9 @@ +.. Autogenerated page: True + +{{ objname | escape | underline }} + +.. currentmodule:: {{ module }} + +.. auto{{ objtype }}:: {{ objname }}{% if objtype in ["class", "exception"] %} + :members: + :show-inheritance:{% endif %} diff --git a/docs/source/conf.py b/docs/source/conf.py index 309d718d9ac..f8e3259cbd5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,6 +43,7 @@ extensions = [ "chango.sphinx_ext", "sphinx.ext.autodoc", + "sphinx.ext.autosummary", "sphinx.ext.napoleon", "sphinx.ext.intersphinx", "sphinx.ext.linkcode", @@ -51,6 +52,7 @@ "sphinx_copybutton", "sphinx_inline_tabs", "sphinxcontrib.mermaid", + "docs.auxil.api_docs", ] # Temporary. See #4387 @@ -80,6 +82,9 @@ # You can specify multiple suffix as a list of string: source_suffix = ".rst" +# API fragments are included by generated dotted-name wrappers. Example pages are read in place. +exclude_patterns = ["telegram/**", "telegram_auxil/**"] + # The master toctree document. master_doc = "index" diff --git a/docs/source/examples.chatmemberbot.rst b/docs/source/examples.chatmemberbot.rst deleted file mode 100644 index a913d340023..00000000000 --- a/docs/source/examples.chatmemberbot.rst +++ /dev/null @@ -1,7 +0,0 @@ -``chatmemberbot.py`` -==================== - -.. literalinclude:: ../../examples/chatmemberbot.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.contexttypesbot.rst b/docs/source/examples.contexttypesbot.rst deleted file mode 100644 index 62438ebc539..00000000000 --- a/docs/source/examples.contexttypesbot.rst +++ /dev/null @@ -1,7 +0,0 @@ -``contexttypesbot.py`` -====================== - -.. literalinclude:: ../../examples/contexttypesbot.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.deeplinking.rst b/docs/source/examples.deeplinking.rst deleted file mode 100644 index 64960d5e550..00000000000 --- a/docs/source/examples.deeplinking.rst +++ /dev/null @@ -1,7 +0,0 @@ -``deeplinking.py`` -================== - -.. literalinclude:: ../../examples/deeplinking.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.echobot.rst b/docs/source/examples.echobot.rst deleted file mode 100644 index a4e2401d375..00000000000 --- a/docs/source/examples.echobot.rst +++ /dev/null @@ -1,7 +0,0 @@ -``echobot.py`` -============== - -.. literalinclude:: ../../examples/echobot.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.errorhandlerbot.rst b/docs/source/examples.errorhandlerbot.rst deleted file mode 100644 index 3df82103332..00000000000 --- a/docs/source/examples.errorhandlerbot.rst +++ /dev/null @@ -1,7 +0,0 @@ -``errorhandlerbot.py`` -====================== - -.. literalinclude:: ../../examples/errorhandlerbot.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.inlinebot.rst b/docs/source/examples.inlinebot.rst deleted file mode 100644 index dcf5df3fdc1..00000000000 --- a/docs/source/examples.inlinebot.rst +++ /dev/null @@ -1,7 +0,0 @@ -``inlinebot.py`` -================ - -.. literalinclude:: ../../examples/inlinebot.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.inlinekeyboard.rst b/docs/source/examples.inlinekeyboard.rst deleted file mode 100644 index 16290cde351..00000000000 --- a/docs/source/examples.inlinekeyboard.rst +++ /dev/null @@ -1,7 +0,0 @@ -``inlinekeyboard.py`` -===================== - -.. literalinclude:: ../../examples/inlinekeyboard.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.inlinekeyboard2.rst b/docs/source/examples.inlinekeyboard2.rst deleted file mode 100644 index 936b4dab25b..00000000000 --- a/docs/source/examples.inlinekeyboard2.rst +++ /dev/null @@ -1,7 +0,0 @@ -``inlinekeyboard2.py`` -====================== - -.. literalinclude:: ../../examples/inlinekeyboard2.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.paymentbot.rst b/docs/source/examples.paymentbot.rst deleted file mode 100644 index dd6c158f2fa..00000000000 --- a/docs/source/examples.paymentbot.rst +++ /dev/null @@ -1,7 +0,0 @@ -``paymentbot.py`` -================= - -.. literalinclude:: ../../examples/paymentbot.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.pollbot.rst b/docs/source/examples.pollbot.rst deleted file mode 100644 index 9fed7231a27..00000000000 --- a/docs/source/examples.pollbot.rst +++ /dev/null @@ -1,7 +0,0 @@ -``pollbot.py`` -============== - -.. literalinclude:: ../../examples/pollbot.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.timerbot.rst b/docs/source/examples.timerbot.rst deleted file mode 100644 index 89f29fb096f..00000000000 --- a/docs/source/examples.timerbot.rst +++ /dev/null @@ -1,7 +0,0 @@ -``timerbot.py`` -=============== - -.. literalinclude:: ../../examples/timerbot.py - :language: python - :linenos: - \ No newline at end of file diff --git a/docs/source/examples.arbitrarycallbackdatabot.rst b/docs/source/examples/arbitrarycallbackdatabot.rst similarity index 50% rename from docs/source/examples.arbitrarycallbackdatabot.rst rename to docs/source/examples/arbitrarycallbackdatabot.rst index 17eb22426e3..328dd937097 100644 --- a/docs/source/examples.arbitrarycallbackdatabot.rst +++ b/docs/source/examples/arbitrarycallbackdatabot.rst @@ -1,7 +1,8 @@ +.. Autogenerated page: False + ``arbitrarycallbackdatabot.py`` =============================== -.. literalinclude:: ../../examples/arbitrarycallbackdatabot.py +.. literalinclude:: ../../../examples/arbitrarycallbackdatabot.py :language: python :linenos: - \ No newline at end of file diff --git a/docs/source/examples/chatmemberbot.rst b/docs/source/examples/chatmemberbot.rst new file mode 100644 index 00000000000..2971b79f515 --- /dev/null +++ b/docs/source/examples/chatmemberbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``chatmemberbot.py`` +==================== + +.. literalinclude:: ../../../examples/chatmemberbot.py + :language: python + :linenos: diff --git a/docs/source/examples/contexttypesbot.rst b/docs/source/examples/contexttypesbot.rst new file mode 100644 index 00000000000..f67ccf0ca0b --- /dev/null +++ b/docs/source/examples/contexttypesbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``contexttypesbot.py`` +====================== + +.. literalinclude:: ../../../examples/contexttypesbot.py + :language: python + :linenos: diff --git a/docs/source/examples.conversationbot.rst b/docs/source/examples/conversationbot.rst similarity index 50% rename from docs/source/examples.conversationbot.rst rename to docs/source/examples/conversationbot.rst index 118f9feef6a..ab3206d66d8 100644 --- a/docs/source/examples.conversationbot.rst +++ b/docs/source/examples/conversationbot.rst @@ -1,7 +1,9 @@ +.. Autogenerated page: False + ``conversationbot.py`` ====================== -.. literalinclude:: ../../examples/conversationbot.py +.. literalinclude:: ../../../examples/conversationbot.py :language: python :linenos: @@ -10,4 +12,4 @@ State Diagram ------------- -.. mermaid:: ../../examples/conversationbot.mmd +.. mermaid:: ../../../examples/conversationbot.mmd diff --git a/docs/source/examples.conversationbot2.rst b/docs/source/examples/conversationbot2.rst similarity index 50% rename from docs/source/examples.conversationbot2.rst rename to docs/source/examples/conversationbot2.rst index 6219ecaabfe..7dc9640d401 100644 --- a/docs/source/examples.conversationbot2.rst +++ b/docs/source/examples/conversationbot2.rst @@ -1,7 +1,9 @@ +.. Autogenerated page: False + ``conversationbot2.py`` ======================= -.. literalinclude:: ../../examples/conversationbot2.py +.. literalinclude:: ../../../examples/conversationbot2.py :language: python :linenos: @@ -10,4 +12,4 @@ State Diagram ------------- -.. mermaid:: ../../examples/conversationbot2.mmd +.. mermaid:: ../../../examples/conversationbot2.mmd diff --git a/docs/source/examples.customwebhookbot.rst b/docs/source/examples/customwebhookbot.rst similarity index 81% rename from docs/source/examples.customwebhookbot.rst rename to docs/source/examples/customwebhookbot.rst index 74722093866..c219213757c 100644 --- a/docs/source/examples.customwebhookbot.rst +++ b/docs/source/examples/customwebhookbot.rst @@ -1,3 +1,5 @@ +.. Autogenerated page: False + ``customwebhookbot.py`` ======================= @@ -19,25 +21,24 @@ You can select your preferred framework by opening one of the tabs above the cod .. tab:: ``starlette`` - .. literalinclude:: ../../examples/customwebhookbot/starlettebot.py + .. literalinclude:: ../../../examples/customwebhookbot/starlettebot.py :language: python :linenos: .. tab:: ``flask`` - .. literalinclude:: ../../examples/customwebhookbot/flaskbot.py + .. literalinclude:: ../../../examples/customwebhookbot/flaskbot.py :language: python :linenos: .. tab:: ``quart`` - .. literalinclude:: ../../examples/customwebhookbot/quartbot.py + .. literalinclude:: ../../../examples/customwebhookbot/quartbot.py :language: python :linenos: .. tab:: ``Django`` - .. literalinclude:: ../../examples/customwebhookbot/djangobot.py + .. literalinclude:: ../../../examples/customwebhookbot/djangobot.py :language: python :linenos: - \ No newline at end of file diff --git a/docs/source/examples/deeplinking.rst b/docs/source/examples/deeplinking.rst new file mode 100644 index 00000000000..15035531b58 --- /dev/null +++ b/docs/source/examples/deeplinking.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``deeplinking.py`` +================== + +.. literalinclude:: ../../../examples/deeplinking.py + :language: python + :linenos: diff --git a/docs/source/examples/echobot.rst b/docs/source/examples/echobot.rst new file mode 100644 index 00000000000..4951b1e8594 --- /dev/null +++ b/docs/source/examples/echobot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``echobot.py`` +============== + +.. literalinclude:: ../../../examples/echobot.py + :language: python + :linenos: diff --git a/docs/source/examples/errorhandlerbot.rst b/docs/source/examples/errorhandlerbot.rst new file mode 100644 index 00000000000..c67a85dcd37 --- /dev/null +++ b/docs/source/examples/errorhandlerbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``errorhandlerbot.py`` +====================== + +.. literalinclude:: ../../../examples/errorhandlerbot.py + :language: python + :linenos: diff --git a/docs/source/examples.rst b/docs/source/examples/index.rst similarity index 81% rename from docs/source/examples.rst rename to docs/source/examples/index.rst index ce87c73450e..a2af26f439a 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples/index.rst @@ -1,3 +1,5 @@ +.. Autogenerated page: False + Examples ======== @@ -6,7 +8,7 @@ In this section we display small examples to show what a bot written with Some bots focus on one specific aspect of the Telegram Bot API while others focus on one of the mechanics of this library. Except for the -:any:`examples.rawapibot` example, they all use the high-level +:doc:`rawapibot` example, they all use the high-level framework this library provides with the :mod:`telegram.ext` submodule. @@ -22,14 +24,14 @@ local variable in those callbacks. However, since these are examples and not having a name for that argument confuses beginners, we decided to have it present. -:any:`examples.echobot` +:doc:`echobot` ----------------------- This is probably the base for most of the bots made with ``python-telegram-bot``. It simply replies to each text message with a message that contains the same text. -:any:`examples.timerbot` +:doc:`timerbot` ------------------------ This bot uses the @@ -41,7 +43,7 @@ also cancel the timer by sending ``/unset``. To learn more about the ``JobQueue``, read `this wiki article `__. Note: To use ``JobQueue``, you must install PTB via ``pip install "python-telegram-bot[job-queue]"`` -:any:`examples.conversationbot` +:doc:`conversationbot` ------------------------------- A common task for a bot is to ask information from the user. In v5.0 of @@ -51,14 +53,14 @@ for that exact purpose. This example uses it to retrieve user-information in a conversation-like style. To get a better understanding, take a look at the :ref:`state diagram `. -:any:`examples.conversationbot2` +:doc:`conversationbot2` -------------------------------- A more complex example of a bot that uses the ``ConversationHandler``. It is also more confusing. Good thing there is a :ref:`fancy state diagram `. for this one, too! -:any:`examples.nestedconversationbot` +:doc:`nestedconversationbot` ------------------------------------- An even more complex example of a bot that uses the nested @@ -68,45 +70,45 @@ gives a good impression on how to work with them. Of course, there is a :ref:`fancy state diagram ` for this example, too! -:any:`examples.persistentconversationbot` +:doc:`persistentconversationbot` ----------------------------------------- A basic example of a bot store conversation state and user_data over multiple restarts. -:any:`examples.inlinekeyboard` +:doc:`inlinekeyboard` ------------------------------ This example sheds some light on inline keyboards, callback queries and message editing. A wiki site explaining this examples lives `here `__. -:any:`examples.inlinekeyboard2` +:doc:`inlinekeyboard2` ------------------------------- 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. -:any:`examples.deeplinking` +:doc:`deeplinking` --------------------------- A basic example on how to use deeplinking with inline keyboards. -:any:`examples.inlinebot` +:doc:`inlinebot` ------------------------- A basic example of an `inline bot `__. Don’t forget to enable inline mode with `@BotFather `_. -:any:`examples.pollbot` +:doc:`pollbot` ----------------------- This example sheds some light on polls, poll answers and the corresponding handlers. -:any:`examples.passportbot` +:doc:`passportbot` --------------------------- A basic example of a bot that can accept passports. Use in combination @@ -117,24 +119,24 @@ Don’t forget to enable and configure payments with on Telegram passports in PTB. Note: To use Telegram Passport, you must install PTB via ``pip install "python-telegram-bot[passport]"`` -:any:`examples.paymentbot` +:doc:`paymentbot` -------------------------- A basic example of a bot that can accept payments. Don’t forget to enable and configure payments with `@BotFather `_. -:any:`examples.errorhandlerbot` +:doc:`errorhandlerbot` ------------------------------- A basic example on how to set up a custom error handler. -:any:`examples.chatmemberbot` +:doc:`chatmemberbot` ----------------------------- A basic example on how ``(my_)chat_member`` updates can be used. -:any:`examples.webappbot` +:doc:`webappbot` ------------------------- A basic example of how `Telegram @@ -146,19 +148,19 @@ don’t need to host it yourself. Uses the user interface that is hard to achieve with native Telegram functionality. -:any:`examples.contexttypesbot` +:doc:`contexttypesbot` ------------------------------- This example showcases how ``telegram.ext.ContextTypes`` can be used to customize the ``context`` argument of handler and job callbacks. -:any:`examples.customwebhookbot` +:doc:`customwebhookbot` -------------------------------- This example showcases how a custom webhook setup can be used in combination with ``telegram.ext.Application``. -:any:`examples.arbitrarycallbackdatabot` +:doc:`arbitrarycallbackdatabot` ---------------------------------------- This example showcases how PTBs “arbitrary callback data” feature can be @@ -168,29 +170,28 @@ Note: To use arbitrary callback data, you must install PTB via ``pip install "py Pure API -------- -The :any:`examples.rawapibot` example example uses only the pure, “bare-metal” API wrapper. +The :doc:`rawapibot` example example uses only the pure, “bare-metal” API wrapper. .. toctree:: :hidden: - examples.arbitrarycallbackdatabot - examples.chatmemberbot - examples.contexttypesbot - examples.conversationbot - examples.conversationbot2 - examples.customwebhookbot - examples.deeplinking - examples.echobot - examples.errorhandlerbot - examples.inlinebot - examples.inlinekeyboard - examples.inlinekeyboard2 - examples.nestedconversationbot - examples.passportbot - examples.paymentbot - examples.persistentconversationbot - examples.pollbot - examples.rawapibot - examples.timerbot - examples.webappbot - + arbitrarycallbackdatabot + chatmemberbot + contexttypesbot + conversationbot + conversationbot2 + customwebhookbot + deeplinking + echobot + errorhandlerbot + inlinebot + inlinekeyboard + inlinekeyboard2 + nestedconversationbot + passportbot + paymentbot + persistentconversationbot + pollbot + rawapibot + timerbot + webappbot diff --git a/docs/source/examples/inlinebot.rst b/docs/source/examples/inlinebot.rst new file mode 100644 index 00000000000..dc64eae587c --- /dev/null +++ b/docs/source/examples/inlinebot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``inlinebot.py`` +================ + +.. literalinclude:: ../../../examples/inlinebot.py + :language: python + :linenos: diff --git a/docs/source/examples/inlinekeyboard.rst b/docs/source/examples/inlinekeyboard.rst new file mode 100644 index 00000000000..8fb3a283a3f --- /dev/null +++ b/docs/source/examples/inlinekeyboard.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``inlinekeyboard.py`` +===================== + +.. literalinclude:: ../../../examples/inlinekeyboard.py + :language: python + :linenos: diff --git a/docs/source/examples/inlinekeyboard2.rst b/docs/source/examples/inlinekeyboard2.rst new file mode 100644 index 00000000000..cba14c89c1a --- /dev/null +++ b/docs/source/examples/inlinekeyboard2.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``inlinekeyboard2.py`` +====================== + +.. literalinclude:: ../../../examples/inlinekeyboard2.py + :language: python + :linenos: diff --git a/docs/source/examples.nestedconversationbot.rst b/docs/source/examples/nestedconversationbot.rst similarity index 51% rename from docs/source/examples.nestedconversationbot.rst rename to docs/source/examples/nestedconversationbot.rst index 23c15053dfb..c497c4a5286 100644 --- a/docs/source/examples.nestedconversationbot.rst +++ b/docs/source/examples/nestedconversationbot.rst @@ -1,7 +1,9 @@ +.. Autogenerated page: False + ``nestedconversationbot.py`` ============================ -.. literalinclude:: ../../examples/nestedconversationbot.py +.. literalinclude:: ../../../examples/nestedconversationbot.py :language: python :linenos: @@ -10,4 +12,4 @@ State Diagram ------------- -.. mermaid:: ../../examples/nestedconversationbot.mmd +.. mermaid:: ../../../examples/nestedconversationbot.mmd diff --git a/docs/source/examples.passportbot.rst b/docs/source/examples/passportbot.rst similarity index 52% rename from docs/source/examples.passportbot.rst rename to docs/source/examples/passportbot.rst index 74c3306c843..9520f78ae5c 100644 --- a/docs/source/examples.passportbot.rst +++ b/docs/source/examples/passportbot.rst @@ -1,7 +1,9 @@ +.. Autogenerated page: False + ``passportbot.py`` ================== -.. literalinclude:: ../../examples/passportbot.py +.. literalinclude:: ../../../examples/passportbot.py :language: python :linenos: @@ -10,7 +12,6 @@ HTML Page --------- -.. literalinclude:: ../../examples/passportbot.html +.. literalinclude:: ../../../examples/passportbot.html :language: html :linenos: - \ No newline at end of file diff --git a/docs/source/examples/paymentbot.rst b/docs/source/examples/paymentbot.rst new file mode 100644 index 00000000000..d6af2135ec6 --- /dev/null +++ b/docs/source/examples/paymentbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``paymentbot.py`` +================= + +.. literalinclude:: ../../../examples/paymentbot.py + :language: python + :linenos: diff --git a/docs/source/examples.persistentconversationbot.rst b/docs/source/examples/persistentconversationbot.rst similarity index 51% rename from docs/source/examples.persistentconversationbot.rst rename to docs/source/examples/persistentconversationbot.rst index 07203fbe80f..ecc2c8d0844 100644 --- a/docs/source/examples.persistentconversationbot.rst +++ b/docs/source/examples/persistentconversationbot.rst @@ -1,7 +1,8 @@ +.. Autogenerated page: False + ``persistentconversationbot.py`` ================================ -.. literalinclude:: ../../examples/persistentconversationbot.py +.. literalinclude:: ../../../examples/persistentconversationbot.py :language: python :linenos: - \ No newline at end of file diff --git a/docs/source/examples/pollbot.rst b/docs/source/examples/pollbot.rst new file mode 100644 index 00000000000..3da53c712cb --- /dev/null +++ b/docs/source/examples/pollbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``pollbot.py`` +============== + +.. literalinclude:: ../../../examples/pollbot.py + :language: python + :linenos: diff --git a/docs/source/examples.rawapibot.rst b/docs/source/examples/rawapibot.rst similarity index 61% rename from docs/source/examples.rawapibot.rst rename to docs/source/examples/rawapibot.rst index 61e66a6e22e..b4fbd43db6c 100644 --- a/docs/source/examples.rawapibot.rst +++ b/docs/source/examples/rawapibot.rst @@ -1,3 +1,5 @@ +.. Autogenerated page: False + `rawapibot.py` ============== @@ -5,7 +7,6 @@ This example uses only the pure, "bare-metal" API wrapper. -.. literalinclude:: ../../examples/rawapibot.py +.. literalinclude:: ../../../examples/rawapibot.py :language: python :linenos: - \ No newline at end of file diff --git a/docs/source/examples/timerbot.rst b/docs/source/examples/timerbot.rst new file mode 100644 index 00000000000..d3a4578abf8 --- /dev/null +++ b/docs/source/examples/timerbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``timerbot.py`` +=============== + +.. literalinclude:: ../../../examples/timerbot.py + :language: python + :linenos: diff --git a/docs/source/examples.webappbot.rst b/docs/source/examples/webappbot.rst similarity index 51% rename from docs/source/examples.webappbot.rst rename to docs/source/examples/webappbot.rst index 55a8141308d..782cc9198f1 100644 --- a/docs/source/examples.webappbot.rst +++ b/docs/source/examples/webappbot.rst @@ -1,7 +1,9 @@ +.. Autogenerated page: False + ``webappbot.py`` ================ -.. literalinclude:: ../../examples/webappbot.py +.. literalinclude:: ../../../examples/webappbot.py :language: python :linenos: @@ -10,7 +12,6 @@ HTML Page --------- -.. literalinclude:: ../../examples/webappbot.html +.. literalinclude:: ../../../examples/webappbot.html :language: html :linenos: - \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index f8aa9e7b647..053e5771435 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -32,7 +32,7 @@ This is just here to get furo to display the right sidebar. :hidden: :caption: Resources - examples + examples/index Wiki .. toctree:: diff --git a/docs/source/telegram.acceptedgifttypes.rst b/docs/source/telegram.acceptedgifttypes.rst index 2926dffd338..eea436aad03 100644 --- a/docs/source/telegram.acceptedgifttypes.rst +++ b/docs/source/telegram.acceptedgifttypes.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + AcceptedGiftTypes ================= -.. autoclass:: telegram.AcceptedGiftTypes +.. currentmodule:: telegram + +.. autoclass:: AcceptedGiftTypes :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.affiliateinfo.rst b/docs/source/telegram.affiliateinfo.rst index 0b2e51863af..ec54f31a6e3 100644 --- a/docs/source/telegram.affiliateinfo.rst +++ b/docs/source/telegram.affiliateinfo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + AffiliateInfo ============= -.. autoclass:: telegram.AffiliateInfo +.. currentmodule:: telegram + +.. autoclass:: AffiliateInfo :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst index 4e654fad49c..34bf457a243 100644 --- a/docs/source/telegram.animation.rst +++ b/docs/source/telegram.animation.rst @@ -1,9 +1,10 @@ +.. Autogenerated page: True + Animation ========= -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject +.. currentmodule:: telegram -.. autoclass:: telegram.Animation +.. autoclass:: Animation :members: - :show-inheritance: - :inherited-members: TelegramObject, object + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.at-tree.rst b/docs/source/telegram.at-tree.rst index 4e638e33864..cb81b2ba7c7 100644 --- a/docs/source/telegram.at-tree.rst +++ b/docs/source/telegram.at-tree.rst @@ -1,231 +1,4 @@ +.. Autogenerated page: True + Available Types --------------- - -.. toctree:: - :titlesonly: - - telegram.acceptedgifttypes - telegram.animation - telegram.audio - telegram.birthdate - telegram.botaccesssettings - telegram.botcommand - telegram.botcommandscope - telegram.botcommandscopeallchatadministrators - telegram.botcommandscopeallgroupchats - telegram.botcommandscopeallprivatechats - telegram.botcommandscopechat - telegram.botcommandscopechatadministrators - telegram.botcommandscopechatmember - telegram.botcommandscopedefault - telegram.botdescription - telegram.botname - telegram.botshortdescription - telegram.businessbotrights - telegram.businessconnection - telegram.businessintro - telegram.businesslocation - telegram.businessopeninghours - telegram.businessopeninghoursinterval - telegram.businessmessagesdeleted - telegram.callbackquery - telegram.chat - telegram.chatadministratorrights - telegram.chatbackground - telegram.checklist - telegram.checklisttask - telegram.checklisttasksadded - telegram.checklisttasksdone - telegram.copytextbutton - telegram.backgroundtype - telegram.backgroundtypefill - telegram.backgroundtypewallpaper - telegram.backgroundtypepattern - telegram.backgroundtypechattheme - telegram.backgroundfill - telegram.backgroundfillsolid - telegram.backgroundfillgradient - telegram.backgroundfillfreeformgradient - telegram.chatboost - telegram.chatboostadded - telegram.chatboostremoved - telegram.chatboostsource - telegram.chatboostsourcegiftcode - telegram.chatboostsourcegiveaway - telegram.chatboostsourcepremium - telegram.chatboostupdated - telegram.chatfullinfo - telegram.chatinvitelink - telegram.chatjoinrequest - telegram.chatlocation - telegram.chatmember - telegram.chatmemberadministrator - telegram.chatmemberbanned - telegram.chatmemberleft - telegram.chatmembermember - telegram.chatmemberowner - telegram.chatmemberrestricted - telegram.chatmemberupdated - telegram.chatownerchanged - telegram.chatownerleft - telegram.chatpermissions - telegram.chatphoto - telegram.chatshared - telegram.contact - telegram.dice - telegram.directmessagepricechanged - telegram.directmessagestopic - telegram.document - telegram.externalreplyinfo - telegram.file - telegram.forcereply - telegram.forumtopic - telegram.forumtopicclosed - telegram.forumtopiccreated - telegram.forumtopicedited - telegram.forumtopicreopened - telegram.generalforumtopichidden - telegram.generalforumtopicunhidden - telegram.giftbackground - telegram.giftinfo - telegram.giveaway - telegram.giveawaycompleted - telegram.giveawaycreated - telegram.giveawaywinners - telegram.inaccessiblemessage - telegram.inlinekeyboardbutton - telegram.inlinekeyboardmarkup - telegram.inputchecklist - telegram.inputchecklisttask - telegram.inputfile - telegram.inputmedia - telegram.inputmediaanimation - telegram.inputmediaaudio - telegram.inputmediadocument - telegram.inputmedialivephoto - telegram.inputmedialocation - telegram.inputmediaphoto - telegram.inputmediasticker - telegram.inputmediavenue - telegram.inputmediavideo - telegram.inputpaidmedia - telegram.inputpaidmedialivephoto - telegram.inputpaidmediaphoto - telegram.inputpaidmediavideo - telegram.inputpollmedia - telegram.inputprofilephoto - telegram.inputprofilephotoanimated - telegram.inputprofilephotostatic - telegram.inputpolloption - telegram.inputpolloptionmedia - telegram.inputstorycontent - telegram.inputstorycontentphoto - telegram.inputstorycontentvideo - telegram.keyboardbutton - telegram.keyboardbuttonpolltype - telegram.keyboardbuttonrequestchat - telegram.keyboardbuttonrequestmanagedbot - telegram.keyboardbuttonrequestusers - telegram.linkpreviewoptions - telegram.livephoto - telegram.location - telegram.locationaddress - telegram.loginurl - telegram.managedbotcreated - telegram.managedbotupdated - telegram.maybeinaccessiblemessage - telegram.menubutton - telegram.menubuttoncommands - telegram.menubuttondefault - telegram.menubuttonwebapp - telegram.message - telegram.messageautodeletetimerchanged - telegram.messageentity - telegram.messageid - telegram.messageorigin - telegram.messageoriginchannel - telegram.messageoriginchat - telegram.messageoriginhiddenuser - telegram.messageoriginuser - telegram.messagereactioncountupdated - telegram.messagereactionupdated - telegram.ownedgift - telegram.ownedgiftregular - telegram.ownedgifts - telegram.ownedgiftunique - telegram.paidmedia - telegram.paidmediainfo - telegram.paidmedialivephoto - telegram.paidmediaphoto - telegram.paidmediapreview - telegram.paidmediapurchased - telegram.paidmediavideo - telegram.paidmessagepricechanged - telegram.photosize - telegram.poll - telegram.pollanswer - telegram.pollmedia - telegram.polloption - telegram.polloptionadded - telegram.polloptiondeleted - telegram.preparedkeyboardbutton - telegram.proximityalerttriggered - telegram.reactioncount - telegram.reactiontype - telegram.reactiontypecustomemoji - telegram.reactiontypeemoji - telegram.reactiontypepaid - telegram.replykeyboardmarkup - telegram.replykeyboardremove - telegram.replyparameters - telegram.sentguestmessage - telegram.sentwebappmessage - telegram.shareduser - telegram.story - telegram.storyarea - telegram.storyareaposition - telegram.storyareatype - telegram.storyareatypelink - telegram.storyareatypelocation - telegram.storyareatypesuggestedreaction - telegram.storyareatypeuniquegift - telegram.storyareatypeweather - telegram.suggestedpostapprovalfailed - telegram.suggestedpostapproved - telegram.suggestedpostdeclined - telegram.suggestedpostinfo - telegram.suggestedpostpaid - telegram.suggestedpostparameters - telegram.suggestedpostprice - telegram.suggestedpostrefunded - telegram.switchinlinequerychosenchat - telegram.telegramobject - telegram.textquote - telegram.uniquegift - telegram.uniquegiftcolors - telegram.uniquegiftbackdrop - telegram.uniquegiftbackdropcolors - telegram.uniquegiftinfo - telegram.uniquegiftmodel - telegram.uniquegiftsymbol - telegram.update - telegram.user - telegram.userchatboosts - telegram.userprofileaudios - telegram.userprofilephotos - telegram.userrating - telegram.usersshared - telegram.venue - telegram.video - telegram.videochatended - telegram.videochatparticipantsinvited - telegram.videochatscheduled - telegram.videochatstarted - telegram.videonote - telegram.videoquality - telegram.voice - telegram.webappdata - telegram.webappinfo - telegram.webhookinfo - telegram.writeaccessallowed - diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst index 563de6c0289..a67bbccfe54 100644 --- a/docs/source/telegram.audio.rst +++ b/docs/source/telegram.audio.rst @@ -1,9 +1,10 @@ +.. Autogenerated page: True + Audio ===== -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject +.. currentmodule:: telegram -.. autoclass:: telegram.Audio +.. autoclass:: Audio :members: - :show-inheritance: - :inherited-members: TelegramObject, object + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfill.rst b/docs/source/telegram.backgroundfill.rst index 0c7c03cb737..185b7a46336 100644 --- a/docs/source/telegram.backgroundfill.rst +++ b/docs/source/telegram.backgroundfill.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundFill ============== -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundFill +.. autoclass:: BackgroundFill :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillfreeformgradient.rst b/docs/source/telegram.backgroundfillfreeformgradient.rst index 663c15e8181..e138a2152d9 100644 --- a/docs/source/telegram.backgroundfillfreeformgradient.rst +++ b/docs/source/telegram.backgroundfillfreeformgradient.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundFillFreeformGradient ============================== -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundFillFreeformGradient +.. autoclass:: BackgroundFillFreeformGradient :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillgradient.rst b/docs/source/telegram.backgroundfillgradient.rst index 313d4bd6468..3d8718efecc 100644 --- a/docs/source/telegram.backgroundfillgradient.rst +++ b/docs/source/telegram.backgroundfillgradient.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundFillGradient ====================== -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundFillGradient +.. autoclass:: BackgroundFillGradient :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillsolid.rst b/docs/source/telegram.backgroundfillsolid.rst index 5130de5f988..0b842d76339 100644 --- a/docs/source/telegram.backgroundfillsolid.rst +++ b/docs/source/telegram.backgroundfillsolid.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundFillSolid =================== -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundFillSolid +.. autoclass:: BackgroundFillSolid :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtype.rst b/docs/source/telegram.backgroundtype.rst index 08e9dc0222a..c885aaee941 100644 --- a/docs/source/telegram.backgroundtype.rst +++ b/docs/source/telegram.backgroundtype.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundType ============== -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundType +.. autoclass:: BackgroundType :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypechattheme.rst b/docs/source/telegram.backgroundtypechattheme.rst index 1d26bde2076..1728bb7644d 100644 --- a/docs/source/telegram.backgroundtypechattheme.rst +++ b/docs/source/telegram.backgroundtypechattheme.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundTypeChatTheme ======================= -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundTypeChatTheme +.. autoclass:: BackgroundTypeChatTheme :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypefill.rst b/docs/source/telegram.backgroundtypefill.rst index 636ff3d7ee2..7c2a9538b3c 100644 --- a/docs/source/telegram.backgroundtypefill.rst +++ b/docs/source/telegram.backgroundtypefill.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundTypeFill ================== -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundTypeFill +.. autoclass:: BackgroundTypeFill :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypepattern.rst b/docs/source/telegram.backgroundtypepattern.rst index 7b14d52bf46..fd4bb24f7e4 100644 --- a/docs/source/telegram.backgroundtypepattern.rst +++ b/docs/source/telegram.backgroundtypepattern.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundTypePattern ===================== -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundTypePattern +.. autoclass:: BackgroundTypePattern :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypewallpaper.rst b/docs/source/telegram.backgroundtypewallpaper.rst index 143c042553b..914bc296771 100644 --- a/docs/source/telegram.backgroundtypewallpaper.rst +++ b/docs/source/telegram.backgroundtypewallpaper.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + BackgroundTypeWallpaper ======================= -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.BackgroundTypeWallpaper +.. autoclass:: BackgroundTypeWallpaper :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.birthdate.rst b/docs/source/telegram.birthdate.rst index 083de5ebf4a..c32e048c450 100644 --- a/docs/source/telegram.birthdate.rst +++ b/docs/source/telegram.birthdate.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + Birthdate ========= -.. autoclass:: telegram.Birthdate - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: Birthdate + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.bot.rst b/docs/source/telegram.bot.rst index 93211517ee4..f5c6df37518 100644 --- a/docs/source/telegram.bot.rst +++ b/docs/source/telegram.bot.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Bot === -.. autoclass:: telegram.Bot +.. currentmodule:: telegram + +.. autoclass:: Bot :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botaccesssettings.rst b/docs/source/telegram.botaccesssettings.rst index 788689b9266..9ecbb626e54 100644 --- a/docs/source/telegram.botaccesssettings.rst +++ b/docs/source/telegram.botaccesssettings.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotAccessSettings ================= -.. autoclass:: telegram.BotAccessSettings +.. currentmodule:: telegram + +.. autoclass:: BotAccessSettings :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommand.rst b/docs/source/telegram.botcommand.rst index a8e710f034f..ade450995dd 100644 --- a/docs/source/telegram.botcommand.rst +++ b/docs/source/telegram.botcommand.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommand ========== -.. autoclass:: telegram.BotCommand +.. currentmodule:: telegram + +.. autoclass:: BotCommand :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscope.rst b/docs/source/telegram.botcommandscope.rst index 9aae8723138..9521b00b3a6 100644 --- a/docs/source/telegram.botcommandscope.rst +++ b/docs/source/telegram.botcommandscope.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommandScope =============== -.. autoclass:: telegram.BotCommandScope +.. currentmodule:: telegram + +.. autoclass:: BotCommandScope :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallchatadministrators.rst b/docs/source/telegram.botcommandscopeallchatadministrators.rst index f33c44a9dd1..eb941e1065c 100644 --- a/docs/source/telegram.botcommandscopeallchatadministrators.rst +++ b/docs/source/telegram.botcommandscopeallchatadministrators.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommandScopeAllChatAdministrators ==================================== -.. autoclass:: telegram.BotCommandScopeAllChatAdministrators +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeAllChatAdministrators :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallgroupchats.rst b/docs/source/telegram.botcommandscopeallgroupchats.rst index 91833b20554..ef05f7176a9 100644 --- a/docs/source/telegram.botcommandscopeallgroupchats.rst +++ b/docs/source/telegram.botcommandscopeallgroupchats.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommandScopeAllGroupChats ============================ -.. autoclass:: telegram.BotCommandScopeAllGroupChats +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeAllGroupChats :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallprivatechats.rst b/docs/source/telegram.botcommandscopeallprivatechats.rst index c0c5cef5c55..66ed7dffbf6 100644 --- a/docs/source/telegram.botcommandscopeallprivatechats.rst +++ b/docs/source/telegram.botcommandscopeallprivatechats.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommandScopeAllPrivateChats ============================== -.. autoclass:: telegram.BotCommandScopeAllPrivateChats +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeAllPrivateChats :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechat.rst b/docs/source/telegram.botcommandscopechat.rst index 9efac3f9d06..852ce8b7316 100644 --- a/docs/source/telegram.botcommandscopechat.rst +++ b/docs/source/telegram.botcommandscopechat.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommandScopeChat =================== -.. autoclass:: telegram.BotCommandScopeChat +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeChat :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechatadministrators.rst b/docs/source/telegram.botcommandscopechatadministrators.rst index e02b6ebdd30..5957f0d0d37 100644 --- a/docs/source/telegram.botcommandscopechatadministrators.rst +++ b/docs/source/telegram.botcommandscopechatadministrators.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommandScopeChatAdministrators ================================= -.. autoclass:: telegram.BotCommandScopeChatAdministrators +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeChatAdministrators :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechatmember.rst b/docs/source/telegram.botcommandscopechatmember.rst index 65c7f63b0b6..2647555b08e 100644 --- a/docs/source/telegram.botcommandscopechatmember.rst +++ b/docs/source/telegram.botcommandscopechatmember.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommandScopeChatMember ========================= -.. autoclass:: telegram.BotCommandScopeChatMember +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeChatMember :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopedefault.rst b/docs/source/telegram.botcommandscopedefault.rst index 89124ef0461..2d45f1d3903 100644 --- a/docs/source/telegram.botcommandscopedefault.rst +++ b/docs/source/telegram.botcommandscopedefault.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotCommandScopeDefault ====================== -.. autoclass:: telegram.BotCommandScopeDefault +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeDefault :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botdescription.rst b/docs/source/telegram.botdescription.rst index 92903aa90ae..56855aa6d44 100644 --- a/docs/source/telegram.botdescription.rst +++ b/docs/source/telegram.botdescription.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotDescription ============== -.. autoclass:: telegram.BotDescription +.. currentmodule:: telegram + +.. autoclass:: BotDescription :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botname.rst b/docs/source/telegram.botname.rst index 0f78027c7ba..44f83549af9 100644 --- a/docs/source/telegram.botname.rst +++ b/docs/source/telegram.botname.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotName ======= -.. autoclass:: telegram.BotName +.. currentmodule:: telegram + +.. autoclass:: BotName :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botshortdescription.rst b/docs/source/telegram.botshortdescription.rst index 76decd628de..b43c42d95b0 100644 --- a/docs/source/telegram.botshortdescription.rst +++ b/docs/source/telegram.botshortdescription.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BotShortDescription =================== -.. autoclass:: telegram.BotShortDescription +.. currentmodule:: telegram + +.. autoclass:: BotShortDescription :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessbotrights.rst b/docs/source/telegram.businessbotrights.rst index d6bdab1a809..b981552c13d 100644 --- a/docs/source/telegram.businessbotrights.rst +++ b/docs/source/telegram.businessbotrights.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessBotRights ================= -.. autoclass:: telegram.BusinessBotRights +.. currentmodule:: telegram + +.. autoclass:: BusinessBotRights :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessconnection.rst b/docs/source/telegram.businessconnection.rst index 3ef31c3b25e..7848c37fbed 100644 --- a/docs/source/telegram.businessconnection.rst +++ b/docs/source/telegram.businessconnection.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessConnection ================== -.. autoclass:: telegram.BusinessConnection +.. currentmodule:: telegram + +.. autoclass:: BusinessConnection :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessintro.rst b/docs/source/telegram.businessintro.rst index 4870258e5b4..e2ae9d25b72 100644 --- a/docs/source/telegram.businessintro.rst +++ b/docs/source/telegram.businessintro.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessIntro -================== +============= + +.. currentmodule:: telegram -.. autoclass:: telegram.BusinessIntro +.. autoclass:: BusinessIntro :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businesslocation.rst b/docs/source/telegram.businesslocation.rst index 1a1b8893b65..6174170c65b 100644 --- a/docs/source/telegram.businesslocation.rst +++ b/docs/source/telegram.businesslocation.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessLocation -================== +================ + +.. currentmodule:: telegram -.. autoclass:: telegram.BusinessLocation +.. autoclass:: BusinessLocation :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessmessagesdeleted.rst b/docs/source/telegram.businessmessagesdeleted.rst index ba0e88e3cba..34d344ef541 100644 --- a/docs/source/telegram.businessmessagesdeleted.rst +++ b/docs/source/telegram.businessmessagesdeleted.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessMessagesDeleted ======================= -.. autoclass:: telegram.BusinessMessagesDeleted +.. currentmodule:: telegram + +.. autoclass:: BusinessMessagesDeleted :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessopeninghours.rst b/docs/source/telegram.businessopeninghours.rst index cab989c8475..c9d3174049d 100644 --- a/docs/source/telegram.businessopeninghours.rst +++ b/docs/source/telegram.businessopeninghours.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessOpeningHours ==================== -.. autoclass:: telegram.BusinessOpeningHours +.. currentmodule:: telegram + +.. autoclass:: BusinessOpeningHours :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessopeninghoursinterval.rst b/docs/source/telegram.businessopeninghoursinterval.rst index 241379dbcfb..3c0cf5133ea 100644 --- a/docs/source/telegram.businessopeninghoursinterval.rst +++ b/docs/source/telegram.businessopeninghoursinterval.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessOpeningHoursInterval ============================ -.. autoclass:: telegram.BusinessOpeningHoursInterval +.. currentmodule:: telegram + +.. autoclass:: BusinessOpeningHoursInterval :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.callbackgame.rst b/docs/source/telegram.callbackgame.rst index c8b47a0a916..6d9779f07cf 100644 --- a/docs/source/telegram.callbackgame.rst +++ b/docs/source/telegram.callbackgame.rst @@ -1,6 +1,10 @@ -Callbackgame +.. Autogenerated page: True + +CallbackGame ============ -.. autoclass:: telegram.CallbackGame +.. currentmodule:: telegram + +.. autoclass:: CallbackGame :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.callbackquery.rst b/docs/source/telegram.callbackquery.rst index 02db37a8a91..c622f0a3386 100644 --- a/docs/source/telegram.callbackquery.rst +++ b/docs/source/telegram.callbackquery.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + CallbackQuery ============= -.. autoclass:: telegram.CallbackQuery +.. currentmodule:: telegram + +.. autoclass:: CallbackQuery :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst index df53940c4a7..df483b4038c 100644 --- a/docs/source/telegram.chat.rst +++ b/docs/source/telegram.chat.rst @@ -1,8 +1,3 @@ -Chat -==== +.. Autogenerated page: True -.. Also lists methods of _ChatBase, but not the ones of TelegramObject -.. autoclass:: telegram.Chat - :members: - :show-inheritance: - :inherited-members: TelegramObject, object +.. include:: telegram/chat.rst diff --git a/docs/source/telegram.chatadministratorrights.rst b/docs/source/telegram.chatadministratorrights.rst index a9aee459bcd..84ccd9e524e 100644 --- a/docs/source/telegram.chatadministratorrights.rst +++ b/docs/source/telegram.chatadministratorrights.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatAdministratorRights ======================= -.. versionadded:: 20.0 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatAdministratorRights +.. autoclass:: ChatAdministratorRights :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatbackground.rst b/docs/source/telegram.chatbackground.rst index 6f43b27fb80..c9338134e65 100644 --- a/docs/source/telegram.chatbackground.rst +++ b/docs/source/telegram.chatbackground.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBackground ============== -.. versionadded:: 21.2 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatBackground +.. autoclass:: ChatBackground :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboost.rst b/docs/source/telegram.chatboost.rst index 460240c6ce4..1e055430658 100644 --- a/docs/source/telegram.chatboost.rst +++ b/docs/source/telegram.chatboost.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBoost ========= -.. versionadded:: 20.8 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatBoost +.. autoclass:: ChatBoost :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostadded.rst b/docs/source/telegram.chatboostadded.rst index b4551e75b84..ee16a8691a1 100644 --- a/docs/source/telegram.chatboostadded.rst +++ b/docs/source/telegram.chatboostadded.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatBoostAdded ============== -.. autoclass:: telegram.ChatBoostAdded +.. currentmodule:: telegram + +.. autoclass:: ChatBoostAdded :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostremoved.rst b/docs/source/telegram.chatboostremoved.rst index ff7e1f37fd7..776eb995cda 100644 --- a/docs/source/telegram.chatboostremoved.rst +++ b/docs/source/telegram.chatboostremoved.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBoostRemoved ================ -.. versionadded:: 20.8 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatBoostRemoved +.. autoclass:: ChatBoostRemoved :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsource.rst b/docs/source/telegram.chatboostsource.rst index ab51f95c640..189ac7bcb7b 100644 --- a/docs/source/telegram.chatboostsource.rst +++ b/docs/source/telegram.chatboostsource.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBoostSource =============== -.. versionadded:: 20.8 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatBoostSource +.. autoclass:: ChatBoostSource :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcegiftcode.rst b/docs/source/telegram.chatboostsourcegiftcode.rst index 8283d286a8c..e7eb4e6a483 100644 --- a/docs/source/telegram.chatboostsourcegiftcode.rst +++ b/docs/source/telegram.chatboostsourcegiftcode.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBoostSourceGiftCode ======================= -.. versionadded:: 20.8 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatBoostSourceGiftCode +.. autoclass:: ChatBoostSourceGiftCode :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcegiveaway.rst b/docs/source/telegram.chatboostsourcegiveaway.rst index a11a8a4ba45..f6caf38807a 100644 --- a/docs/source/telegram.chatboostsourcegiveaway.rst +++ b/docs/source/telegram.chatboostsourcegiveaway.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBoostSourceGiveaway ======================= -.. versionadded:: 20.8 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatBoostSourceGiveaway +.. autoclass:: ChatBoostSourceGiveaway :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcepremium.rst b/docs/source/telegram.chatboostsourcepremium.rst index 78f2c5dfd19..d81378c4039 100644 --- a/docs/source/telegram.chatboostsourcepremium.rst +++ b/docs/source/telegram.chatboostsourcepremium.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBoostSourcePremium ====================== -.. versionadded:: 20.8 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatBoostSourcePremium +.. autoclass:: ChatBoostSourcePremium :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostupdated.rst b/docs/source/telegram.chatboostupdated.rst index 9fc99a62d93..9481ed8a6c5 100644 --- a/docs/source/telegram.chatboostupdated.rst +++ b/docs/source/telegram.chatboostupdated.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBoostUpdated ================ -.. versionadded:: 20.8 +.. currentmodule:: telegram -.. autoclass:: telegram.ChatBoostUpdated +.. autoclass:: ChatBoostUpdated :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatfullinfo.rst b/docs/source/telegram.chatfullinfo.rst index 7ba8f3d3828..93bd891d5a9 100644 --- a/docs/source/telegram.chatfullinfo.rst +++ b/docs/source/telegram.chatfullinfo.rst @@ -1,8 +1,3 @@ -ChatFullInfo -============ +.. Autogenerated page: True -.. Also lists methods of _ChatBase, but not the ones of TelegramObject -.. autoclass:: telegram.ChatFullInfo - :members: - :show-inheritance: - :inherited-members: TelegramObject, object \ No newline at end of file +.. include:: telegram/chatfullinfo.rst diff --git a/docs/source/telegram.chatinvitelink.rst b/docs/source/telegram.chatinvitelink.rst index 3314af1ec25..7b4366e3224 100644 --- a/docs/source/telegram.chatinvitelink.rst +++ b/docs/source/telegram.chatinvitelink.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatInviteLink ============== -.. autoclass:: telegram.ChatInviteLink +.. currentmodule:: telegram + +.. autoclass:: ChatInviteLink :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatjoinrequest.rst b/docs/source/telegram.chatjoinrequest.rst index 8c4f5cb273d..e2ab2700aaf 100644 --- a/docs/source/telegram.chatjoinrequest.rst +++ b/docs/source/telegram.chatjoinrequest.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatJoinRequest =============== -.. autoclass:: telegram.ChatJoinRequest +.. currentmodule:: telegram + +.. autoclass:: ChatJoinRequest :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatlocation.rst b/docs/source/telegram.chatlocation.rst index 12b5e2127a1..bbbd5edc16e 100644 --- a/docs/source/telegram.chatlocation.rst +++ b/docs/source/telegram.chatlocation.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatLocation ============ -.. autoclass:: telegram.ChatLocation +.. currentmodule:: telegram + +.. autoclass:: ChatLocation :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmember.rst b/docs/source/telegram.chatmember.rst index 771b3636dee..2e9a8e67a4b 100644 --- a/docs/source/telegram.chatmember.rst +++ b/docs/source/telegram.chatmember.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatMember ========== -.. autoclass:: telegram.ChatMember +.. currentmodule:: telegram + +.. autoclass:: ChatMember :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberadministrator.rst b/docs/source/telegram.chatmemberadministrator.rst index b9b385328f3..6d29520fb72 100644 --- a/docs/source/telegram.chatmemberadministrator.rst +++ b/docs/source/telegram.chatmemberadministrator.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatMemberAdministrator ======================= -.. autoclass:: telegram.ChatMemberAdministrator +.. currentmodule:: telegram + +.. autoclass:: ChatMemberAdministrator :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberbanned.rst b/docs/source/telegram.chatmemberbanned.rst index f3d3fb7b6e2..97d2c99e127 100644 --- a/docs/source/telegram.chatmemberbanned.rst +++ b/docs/source/telegram.chatmemberbanned.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatMemberBanned ================ -.. autoclass:: telegram.ChatMemberBanned +.. currentmodule:: telegram + +.. autoclass:: ChatMemberBanned :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberleft.rst b/docs/source/telegram.chatmemberleft.rst index c692f73df52..fcaf2ec725d 100644 --- a/docs/source/telegram.chatmemberleft.rst +++ b/docs/source/telegram.chatmemberleft.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatMemberLeft ============== -.. autoclass:: telegram.ChatMemberLeft +.. currentmodule:: telegram + +.. autoclass:: ChatMemberLeft :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmembermember.rst b/docs/source/telegram.chatmembermember.rst index 6a472380397..9cee283bb88 100644 --- a/docs/source/telegram.chatmembermember.rst +++ b/docs/source/telegram.chatmembermember.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatMemberMember ================ -.. autoclass:: telegram.ChatMemberMember +.. currentmodule:: telegram + +.. autoclass:: ChatMemberMember :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberowner.rst b/docs/source/telegram.chatmemberowner.rst index 6f5217a3c9c..cf11128b7f9 100644 --- a/docs/source/telegram.chatmemberowner.rst +++ b/docs/source/telegram.chatmemberowner.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + ChatMemberOwner =============== -.. autoclass:: telegram.ChatMemberOwner - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: ChatMemberOwner + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberrestricted.rst b/docs/source/telegram.chatmemberrestricted.rst index 97b5d3ec2c0..4eadf9c4cde 100644 --- a/docs/source/telegram.chatmemberrestricted.rst +++ b/docs/source/telegram.chatmemberrestricted.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatMemberRestricted ==================== -.. autoclass:: telegram.ChatMemberRestricted +.. currentmodule:: telegram + +.. autoclass:: ChatMemberRestricted :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberupdated.rst b/docs/source/telegram.chatmemberupdated.rst index 3c4dcf0a8cd..91d9f10c965 100644 --- a/docs/source/telegram.chatmemberupdated.rst +++ b/docs/source/telegram.chatmemberupdated.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatMemberUpdated ================= -.. autoclass:: telegram.ChatMemberUpdated +.. currentmodule:: telegram + +.. autoclass:: ChatMemberUpdated :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatownerchanged.rst b/docs/source/telegram.chatownerchanged.rst index fe8251fb349..7864e8e1b9f 100644 --- a/docs/source/telegram.chatownerchanged.rst +++ b/docs/source/telegram.chatownerchanged.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatOwnerChanged ================ -.. autoclass:: telegram.ChatOwnerChanged +.. currentmodule:: telegram + +.. autoclass:: ChatOwnerChanged :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatownerleft.rst b/docs/source/telegram.chatownerleft.rst index 62cb226d08f..79ab3bb18f2 100644 --- a/docs/source/telegram.chatownerleft.rst +++ b/docs/source/telegram.chatownerleft.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatOwnerLeft ============= -.. autoclass:: telegram.ChatOwnerLeft +.. currentmodule:: telegram + +.. autoclass:: ChatOwnerLeft :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatpermissions.rst b/docs/source/telegram.chatpermissions.rst index d14479bb229..b4466565896 100644 --- a/docs/source/telegram.chatpermissions.rst +++ b/docs/source/telegram.chatpermissions.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatPermissions =============== -.. autoclass:: telegram.ChatPermissions +.. currentmodule:: telegram + +.. autoclass:: ChatPermissions :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatphoto.rst b/docs/source/telegram.chatphoto.rst index b5f337e9b5b..fcbe9707ed6 100644 --- a/docs/source/telegram.chatphoto.rst +++ b/docs/source/telegram.chatphoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatPhoto ========= -.. autoclass:: telegram.ChatPhoto +.. currentmodule:: telegram + +.. autoclass:: ChatPhoto :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatshared.rst b/docs/source/telegram.chatshared.rst index 5c654f7cb61..70a6f95bdc9 100644 --- a/docs/source/telegram.chatshared.rst +++ b/docs/source/telegram.chatshared.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatShared -=================== +========== + +.. currentmodule:: telegram -.. autoclass:: telegram.ChatShared +.. autoclass:: ChatShared :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.checklist.rst b/docs/source/telegram.checklist.rst index a01dac43aad..8be79d85ead 100644 --- a/docs/source/telegram.checklist.rst +++ b/docs/source/telegram.checklist.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Checklist ========= -.. autoclass:: telegram.Checklist +.. currentmodule:: telegram + +.. autoclass:: Checklist :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.checklisttask.rst b/docs/source/telegram.checklisttask.rst index 27f44d629de..77e5bf73aa6 100644 --- a/docs/source/telegram.checklisttask.rst +++ b/docs/source/telegram.checklisttask.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChecklistTask ============= -.. autoclass:: telegram.ChecklistTask +.. currentmodule:: telegram + +.. autoclass:: ChecklistTask :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.checklisttasksadded.rst b/docs/source/telegram.checklisttasksadded.rst index d3c33c02300..f575b27b417 100644 --- a/docs/source/telegram.checklisttasksadded.rst +++ b/docs/source/telegram.checklisttasksadded.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChecklistTasksAdded =================== -.. autoclass:: telegram.ChecklistTasksAdded +.. currentmodule:: telegram + +.. autoclass:: ChecklistTasksAdded :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.checklisttasksdone.rst b/docs/source/telegram.checklisttasksdone.rst index aa1e0b83f84..fe6a8eeaf28 100644 --- a/docs/source/telegram.checklisttasksdone.rst +++ b/docs/source/telegram.checklisttasksdone.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChecklistTasksDone ================== -.. autoclass:: telegram.ChecklistTasksDone +.. currentmodule:: telegram + +.. autoclass:: ChecklistTasksDone :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.choseninlineresult.rst b/docs/source/telegram.choseninlineresult.rst index e357c1e07e9..25f0979eeae 100644 --- a/docs/source/telegram.choseninlineresult.rst +++ b/docs/source/telegram.choseninlineresult.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChosenInlineResult ================== -.. autoclass:: telegram.ChosenInlineResult +.. currentmodule:: telegram + +.. autoclass:: ChosenInlineResult :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.constants.rst b/docs/source/telegram.constants.rst index 618b35246f1..4ee00be0d45 100644 --- a/docs/source/telegram.constants.rst +++ b/docs/source/telegram.constants.rst @@ -1,8 +1,3 @@ -telegram.constants Module -========================= +.. Autogenerated page: True -.. automodule:: telegram.constants - :members: - :show-inheritance: - :no-undoc-members: - :exclude-members: __format__, __new__, __repr__, __str__ +.. include:: telegram/constants.rst diff --git a/docs/source/telegram.contact.rst b/docs/source/telegram.contact.rst index 682b4345884..d1466e4b7db 100644 --- a/docs/source/telegram.contact.rst +++ b/docs/source/telegram.contact.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Contact ======= -.. autoclass:: telegram.Contact +.. currentmodule:: telegram + +.. autoclass:: Contact :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.copytextbutton.rst b/docs/source/telegram.copytextbutton.rst index 7110fbf8b6b..08af180b14f 100644 --- a/docs/source/telegram.copytextbutton.rst +++ b/docs/source/telegram.copytextbutton.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + CopyTextButton ============== -.. autoclass:: telegram.CopyTextButton +.. currentmodule:: telegram + +.. autoclass:: CopyTextButton :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.credentials.rst b/docs/source/telegram.credentials.rst index 0b6cc68d207..2ab700df2ec 100644 --- a/docs/source/telegram.credentials.rst +++ b/docs/source/telegram.credentials.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Credentials =========== -.. autoclass:: telegram.Credentials +.. currentmodule:: telegram + +.. autoclass:: Credentials :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.datacredentials.rst b/docs/source/telegram.datacredentials.rst index f6bc8643f03..72f6f639327 100644 --- a/docs/source/telegram.datacredentials.rst +++ b/docs/source/telegram.datacredentials.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + DataCredentials =============== -.. autoclass:: telegram.DataCredentials +.. currentmodule:: telegram + +.. autoclass:: DataCredentials :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.dice.rst b/docs/source/telegram.dice.rst index 827935d670d..6b5db896628 100644 --- a/docs/source/telegram.dice.rst +++ b/docs/source/telegram.dice.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Dice ==== -.. autoclass:: telegram.Dice +.. currentmodule:: telegram + +.. autoclass:: Dice :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.directmessagepricechanged.rst b/docs/source/telegram.directmessagepricechanged.rst index 64356e1a689..37abc4def6e 100644 --- a/docs/source/telegram.directmessagepricechanged.rst +++ b/docs/source/telegram.directmessagepricechanged.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + DirectMessagePriceChanged ========================= -.. autoclass:: telegram.DirectMessagePriceChanged +.. currentmodule:: telegram + +.. autoclass:: DirectMessagePriceChanged :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.directmessagestopic.rst b/docs/source/telegram.directmessagestopic.rst index 9779a021c91..a7ba911696e 100644 --- a/docs/source/telegram.directmessagestopic.rst +++ b/docs/source/telegram.directmessagestopic.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + DirectMessagesTopic =================== -.. autoclass:: telegram.DirectMessagesTopic +.. currentmodule:: telegram + +.. autoclass:: DirectMessagesTopic :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst index 1a337077069..f5454c82710 100644 --- a/docs/source/telegram.document.rst +++ b/docs/source/telegram.document.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + Document ======== -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject -.. autoclass:: telegram.Document +.. currentmodule:: telegram + +.. autoclass:: Document :members: - :show-inheritance: - :inherited-members: TelegramObject, object + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.encryptedcredentials.rst b/docs/source/telegram.encryptedcredentials.rst index 7c7a61c83a3..234e85738b9 100644 --- a/docs/source/telegram.encryptedcredentials.rst +++ b/docs/source/telegram.encryptedcredentials.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + EncryptedCredentials ==================== -.. autoclass:: telegram.EncryptedCredentials +.. currentmodule:: telegram + +.. autoclass:: EncryptedCredentials :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.encryptedpassportelement.rst b/docs/source/telegram.encryptedpassportelement.rst index 0204af1ee47..6930aa8d027 100644 --- a/docs/source/telegram.encryptedpassportelement.rst +++ b/docs/source/telegram.encryptedpassportelement.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + EncryptedPassportElement ======================== -.. autoclass:: telegram.EncryptedPassportElement +.. currentmodule:: telegram + +.. autoclass:: EncryptedPassportElement :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.error.rst b/docs/source/telegram.error.rst index c5cd7aee0de..2ba25a41be2 100644 --- a/docs/source/telegram.error.rst +++ b/docs/source/telegram.error.rst @@ -1,6 +1,3 @@ -telegram.error Module -===================== +.. Autogenerated page: True -.. automodule:: telegram.error - :members: - :show-inheritance: +.. include:: telegram/error.rst diff --git a/docs/source/telegram.ext.acd-tree.rst b/docs/source/telegram.ext.acd-tree.rst index 0ce4efda72c..8f407b9bc6a 100644 --- a/docs/source/telegram.ext.acd-tree.rst +++ b/docs/source/telegram.ext.acd-tree.rst @@ -1,8 +1,6 @@ -Arbitrary Callback Data ------------------------ +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _acd-tree: - telegram.ext.callbackdatacache - telegram.ext.invalidcallbackdata +Arbitrary Callback Data +----------------------- diff --git a/docs/source/telegram.ext.aioratelimiter.rst b/docs/source/telegram.ext.aioratelimiter.rst index de329f07770..be0e1a8a26b 100644 --- a/docs/source/telegram.ext.aioratelimiter.rst +++ b/docs/source/telegram.ext.aioratelimiter.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + AIORateLimiter ============== -.. autoclass:: telegram.ext.AIORateLimiter +.. currentmodule:: telegram.ext + +.. autoclass:: AIORateLimiter :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.application.rst b/docs/source/telegram.ext.application.rst index 4b1a3f25991..6099cbfbc88 100644 --- a/docs/source/telegram.ext.application.rst +++ b/docs/source/telegram.ext.application.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Application =========== -.. autoclass:: telegram.ext.Application +.. currentmodule:: telegram.ext + +.. autoclass:: Application :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.applicationbuilder.rst b/docs/source/telegram.ext.applicationbuilder.rst index ec0a6574cdd..3ed17141482 100644 --- a/docs/source/telegram.ext.applicationbuilder.rst +++ b/docs/source/telegram.ext.applicationbuilder.rst @@ -1,5 +1,3 @@ -ApplicationBuilder -================== +.. Autogenerated page: True -.. autoclass:: telegram.ext.ApplicationBuilder - :members: +.. include:: telegram/ext/applicationbuilder.rst diff --git a/docs/source/telegram.ext.applicationhandlerstop.rst b/docs/source/telegram.ext.applicationhandlerstop.rst index db536aee178..cd67ac4b8b0 100644 --- a/docs/source/telegram.ext.applicationhandlerstop.rst +++ b/docs/source/telegram.ext.applicationhandlerstop.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ApplicationHandlerStop ====================== -.. autoclass:: telegram.ext.ApplicationHandlerStop +.. currentmodule:: telegram.ext + +.. autoexception:: ApplicationHandlerStop :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.basehandler.rst b/docs/source/telegram.ext.basehandler.rst index 9dfd607cee8..29853a1c6fe 100644 --- a/docs/source/telegram.ext.basehandler.rst +++ b/docs/source/telegram.ext.basehandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BaseHandler =========== -.. autoclass:: telegram.ext.BaseHandler +.. currentmodule:: telegram.ext + +.. autoclass:: BaseHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.basepersistence.rst b/docs/source/telegram.ext.basepersistence.rst index c45fcf65b4f..593a39080c0 100644 --- a/docs/source/telegram.ext.basepersistence.rst +++ b/docs/source/telegram.ext.basepersistence.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BasePersistence =============== -.. autoclass:: telegram.ext.BasePersistence +.. currentmodule:: telegram.ext + +.. autoclass:: BasePersistence :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.baseratelimiter.rst b/docs/source/telegram.ext.baseratelimiter.rst index 1d41db92b85..192139062d6 100644 --- a/docs/source/telegram.ext.baseratelimiter.rst +++ b/docs/source/telegram.ext.baseratelimiter.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BaseRateLimiter =============== -.. autoclass:: telegram.ext.BaseRateLimiter +.. currentmodule:: telegram.ext + +.. autoclass:: BaseRateLimiter :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.baseupdateprocessor.rst b/docs/source/telegram.ext.baseupdateprocessor.rst index 7155adf7191..c2a2f4dceea 100644 --- a/docs/source/telegram.ext.baseupdateprocessor.rst +++ b/docs/source/telegram.ext.baseupdateprocessor.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BaseUpdateProcessor =================== -.. autoclass:: telegram.ext.BaseUpdateProcessor +.. currentmodule:: telegram.ext + +.. autoclass:: BaseUpdateProcessor :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.businessconnectionhandler.rst b/docs/source/telegram.ext.businessconnectionhandler.rst index 0b0509dff2f..742c81d1727 100644 --- a/docs/source/telegram.ext.businessconnectionhandler.rst +++ b/docs/source/telegram.ext.businessconnectionhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessConnectionHandler ========================= -.. autoclass:: telegram.ext.BusinessConnectionHandler +.. currentmodule:: telegram.ext + +.. autoclass:: BusinessConnectionHandler :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.businessmessagesdeletedhandler.rst b/docs/source/telegram.ext.businessmessagesdeletedhandler.rst index 840f19325a0..bcd78b68700 100644 --- a/docs/source/telegram.ext.businessmessagesdeletedhandler.rst +++ b/docs/source/telegram.ext.businessmessagesdeletedhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BusinessMessagesDeletedHandler ============================== -.. autoclass:: telegram.ext.BusinessMessagesDeletedHandler +.. currentmodule:: telegram.ext + +.. autoclass:: BusinessMessagesDeletedHandler :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.callbackcontext.rst b/docs/source/telegram.ext.callbackcontext.rst index f88241d0dda..b608121d43a 100644 --- a/docs/source/telegram.ext.callbackcontext.rst +++ b/docs/source/telegram.ext.callbackcontext.rst @@ -1,5 +1,3 @@ -CallbackContext -=============== +.. Autogenerated page: True -.. autoclass:: telegram.ext.CallbackContext - :members: +.. include:: telegram/ext/callbackcontext.rst diff --git a/docs/source/telegram.ext.callbackdatacache.rst b/docs/source/telegram.ext.callbackdatacache.rst index 0ad16d09659..7d24170315f 100644 --- a/docs/source/telegram.ext.callbackdatacache.rst +++ b/docs/source/telegram.ext.callbackdatacache.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + CallbackDataCache ================= -.. autoclass:: telegram.ext.CallbackDataCache +.. currentmodule:: telegram.ext + +.. autoclass:: CallbackDataCache :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.callbackqueryhandler.rst b/docs/source/telegram.ext.callbackqueryhandler.rst index 1414993bb4f..ba08e56700f 100644 --- a/docs/source/telegram.ext.callbackqueryhandler.rst +++ b/docs/source/telegram.ext.callbackqueryhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + CallbackQueryHandler ==================== -.. autoclass:: telegram.ext.CallbackQueryHandler +.. currentmodule:: telegram.ext + +.. autoclass:: CallbackQueryHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.chatboosthandler.rst b/docs/source/telegram.ext.chatboosthandler.rst index 992972600d4..dbeded1592b 100644 --- a/docs/source/telegram.ext.chatboosthandler.rst +++ b/docs/source/telegram.ext.chatboosthandler.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + ChatBoostHandler ================ -.. versionadded:: 20.8 +.. currentmodule:: telegram.ext -.. autoclass:: telegram.ext.ChatBoostHandler +.. autoclass:: ChatBoostHandler :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.chatjoinrequesthandler.rst b/docs/source/telegram.ext.chatjoinrequesthandler.rst index 7f860a8fc81..01ea4b1a341 100644 --- a/docs/source/telegram.ext.chatjoinrequesthandler.rst +++ b/docs/source/telegram.ext.chatjoinrequesthandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatJoinRequestHandler ====================== -.. autoclass:: telegram.ext.ChatJoinRequestHandler +.. currentmodule:: telegram.ext + +.. autoclass:: ChatJoinRequestHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.chatmemberhandler.rst b/docs/source/telegram.ext.chatmemberhandler.rst index e2662c30804..47c93c6dfa6 100644 --- a/docs/source/telegram.ext.chatmemberhandler.rst +++ b/docs/source/telegram.ext.chatmemberhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChatMemberHandler ================= -.. autoclass:: telegram.ext.ChatMemberHandler +.. currentmodule:: telegram.ext + +.. autoclass:: ChatMemberHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.choseninlineresulthandler.rst b/docs/source/telegram.ext.choseninlineresulthandler.rst index 19a0d975c29..f8f8074bbd7 100644 --- a/docs/source/telegram.ext.choseninlineresulthandler.rst +++ b/docs/source/telegram.ext.choseninlineresulthandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ChosenInlineResultHandler ========================= -.. autoclass:: telegram.ext.ChosenInlineResultHandler +.. currentmodule:: telegram.ext + +.. autoclass:: ChosenInlineResultHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.commandhandler.rst b/docs/source/telegram.ext.commandhandler.rst index 91d7be06596..f00d457c11a 100644 --- a/docs/source/telegram.ext.commandhandler.rst +++ b/docs/source/telegram.ext.commandhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + CommandHandler ============== -.. autoclass:: telegram.ext.CommandHandler +.. currentmodule:: telegram.ext + +.. autoclass:: CommandHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.contexttypes.rst b/docs/source/telegram.ext.contexttypes.rst index ef15bf7131b..0a5cb44a50e 100644 --- a/docs/source/telegram.ext.contexttypes.rst +++ b/docs/source/telegram.ext.contexttypes.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ContextTypes ============ -.. autoclass:: telegram.ext.ContextTypes +.. currentmodule:: telegram.ext + +.. autoclass:: ContextTypes :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.conversationhandler.rst b/docs/source/telegram.ext.conversationhandler.rst index 3ec96f1fdd6..ae57dd0f883 100644 --- a/docs/source/telegram.ext.conversationhandler.rst +++ b/docs/source/telegram.ext.conversationhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ConversationHandler =================== -.. autoclass:: telegram.ext.ConversationHandler +.. currentmodule:: telegram.ext + +.. autoclass:: ConversationHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.defaults.rst b/docs/source/telegram.ext.defaults.rst index 365494614f9..b02fc22ce35 100644 --- a/docs/source/telegram.ext.defaults.rst +++ b/docs/source/telegram.ext.defaults.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Defaults ======== -.. autoclass:: telegram.ext.Defaults +.. currentmodule:: telegram.ext + +.. autoclass:: Defaults :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.dictpersistence.rst b/docs/source/telegram.ext.dictpersistence.rst index d9f3ab56ae2..73bbdae7eef 100644 --- a/docs/source/telegram.ext.dictpersistence.rst +++ b/docs/source/telegram.ext.dictpersistence.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + DictPersistence =============== -.. autoclass:: telegram.ext.DictPersistence +.. currentmodule:: telegram.ext + +.. autoclass:: DictPersistence :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.extbot.rst b/docs/source/telegram.ext.extbot.rst index d61a36b0789..395e29e630e 100644 --- a/docs/source/telegram.ext.extbot.rst +++ b/docs/source/telegram.ext.extbot.rst @@ -1,6 +1,3 @@ -ExtBot -====== +.. Autogenerated page: True -.. autoclass:: telegram.ext.ExtBot - :show-inheritance: - :members: insert_callback_data, defaults, rate_limiter, initialize, shutdown, callback_data_cache +.. include:: telegram/ext/extbot.rst diff --git a/docs/source/telegram.ext.filters.rst b/docs/source/telegram.ext.filters.rst index 7762ab01036..db01bdb2fd5 100644 --- a/docs/source/telegram.ext.filters.rst +++ b/docs/source/telegram.ext.filters.rst @@ -1,11 +1,3 @@ -filters Module -============== +.. Autogenerated page: True -.. :bysource: since e.g filters.CHAT is much above filters.Chat() in the docs when it shouldn't. - The classes in `filters.py` are sorted alphabetically such that :bysource: still is readable - -.. automodule:: telegram.ext.filters - :inherited-members: BaseFilter, MessageFilter, UpdateFilter, object - :members: - :show-inheritance: - :member-order: bysource \ No newline at end of file +.. include:: telegram/ext/filters.rst diff --git a/docs/source/telegram.ext.handlers-tree.rst b/docs/source/telegram.ext.handlers-tree.rst index 690aca1c537..01b34834536 100644 --- a/docs/source/telegram.ext.handlers-tree.rst +++ b/docs/source/telegram.ext.handlers-tree.rst @@ -1,30 +1,6 @@ -Handlers --------- +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _handlers-tree: - telegram.ext.basehandler - telegram.ext.businessconnectionhandler - telegram.ext.businessmessagesdeletedhandler - telegram.ext.callbackqueryhandler - telegram.ext.chatboosthandler - telegram.ext.chatjoinrequesthandler - telegram.ext.chatmemberhandler - telegram.ext.choseninlineresulthandler - telegram.ext.commandhandler - telegram.ext.conversationhandler - telegram.ext.filters - telegram.ext.inlinequeryhandler - telegram.ext.managedbotupdatedhandler - telegram.ext.messagehandler - telegram.ext.messagereactionhandler - telegram.ext.paidmediapurchasedhandler - telegram.ext.pollanswerhandler - telegram.ext.pollhandler - telegram.ext.precheckoutqueryhandler - telegram.ext.prefixhandler - telegram.ext.shippingqueryhandler - telegram.ext.stringcommandhandler - telegram.ext.stringregexhandler - telegram.ext.typehandler +Handlers +-------- diff --git a/docs/source/telegram.ext.inlinequeryhandler.rst b/docs/source/telegram.ext.inlinequeryhandler.rst index 26469d99798..7deddb5f320 100644 --- a/docs/source/telegram.ext.inlinequeryhandler.rst +++ b/docs/source/telegram.ext.inlinequeryhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryHandler ================== -.. autoclass:: telegram.ext.InlineQueryHandler +.. currentmodule:: telegram.ext + +.. autoclass:: InlineQueryHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.invalidcallbackdata.rst b/docs/source/telegram.ext.invalidcallbackdata.rst index 7bfc7e451ee..5363fb6a294 100644 --- a/docs/source/telegram.ext.invalidcallbackdata.rst +++ b/docs/source/telegram.ext.invalidcallbackdata.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InvalidCallbackData =================== -.. autoclass:: telegram.ext.InvalidCallbackData +.. currentmodule:: telegram.ext + +.. autoexception:: InvalidCallbackData :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.job.rst b/docs/source/telegram.ext.job.rst index 0f69756b371..bdaeb990c79 100644 --- a/docs/source/telegram.ext.job.rst +++ b/docs/source/telegram.ext.job.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Job === -.. autoclass:: telegram.ext.Job +.. currentmodule:: telegram.ext + +.. autoclass:: Job :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.jobqueue.rst b/docs/source/telegram.ext.jobqueue.rst index 75658e30d3f..d84c4579a0d 100644 --- a/docs/source/telegram.ext.jobqueue.rst +++ b/docs/source/telegram.ext.jobqueue.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + JobQueue ======== -.. autoclass:: telegram.ext.JobQueue +.. currentmodule:: telegram.ext + +.. autoclass:: JobQueue :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.managedbotupdatedhandler.rst b/docs/source/telegram.ext.managedbotupdatedhandler.rst index c59d8080389..8575e979493 100644 --- a/docs/source/telegram.ext.managedbotupdatedhandler.rst +++ b/docs/source/telegram.ext.managedbotupdatedhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ManagedBotUpdatedHandler ======================== -.. autoclass:: telegram.ext.ManagedBotUpdatedHandler +.. currentmodule:: telegram.ext + +.. autoclass:: ManagedBotUpdatedHandler :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.messagehandler.rst b/docs/source/telegram.ext.messagehandler.rst index 2292eb44573..b609415a17b 100644 --- a/docs/source/telegram.ext.messagehandler.rst +++ b/docs/source/telegram.ext.messagehandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageHandler ============== -.. autoclass:: telegram.ext.MessageHandler +.. currentmodule:: telegram.ext + +.. autoclass:: MessageHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.messagereactionhandler.rst b/docs/source/telegram.ext.messagereactionhandler.rst index 1aad333ff1c..2b2a7f3bf2a 100644 --- a/docs/source/telegram.ext.messagereactionhandler.rst +++ b/docs/source/telegram.ext.messagereactionhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageReactionHandler ====================== -.. autoclass:: telegram.ext.MessageReactionHandler +.. currentmodule:: telegram.ext + +.. autoclass:: MessageReactionHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.paidmediapurchasedhandler.rst b/docs/source/telegram.ext.paidmediapurchasedhandler.rst index 19bfbeea31e..cc87452c18b 100644 --- a/docs/source/telegram.ext.paidmediapurchasedhandler.rst +++ b/docs/source/telegram.ext.paidmediapurchasedhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMediaPurchasedHandler ========================= -.. autoclass:: telegram.ext.PaidMediaPurchasedHandler +.. currentmodule:: telegram.ext + +.. autoclass:: PaidMediaPurchasedHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.persistence-tree.rst b/docs/source/telegram.ext.persistence-tree.rst index c17d7bd5555..3307f1f4fb5 100644 --- a/docs/source/telegram.ext.persistence-tree.rst +++ b/docs/source/telegram.ext.persistence-tree.rst @@ -1,10 +1,6 @@ -Persistence ------------ +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _persistence-tree: - telegram.ext.basepersistence - telegram.ext.dictpersistence - telegram.ext.persistenceinput - telegram.ext.picklepersistence +Persistence +----------- diff --git a/docs/source/telegram.ext.persistenceinput.rst b/docs/source/telegram.ext.persistenceinput.rst index 4a1bc282295..09e023a52c4 100644 --- a/docs/source/telegram.ext.persistenceinput.rst +++ b/docs/source/telegram.ext.persistenceinput.rst @@ -1,5 +1,3 @@ -PersistenceInput -================ +.. Autogenerated page: True -.. autoclass:: telegram.ext.PersistenceInput - :show-inheritance: +.. include:: telegram/ext/persistenceinput.rst diff --git a/docs/source/telegram.ext.picklepersistence.rst b/docs/source/telegram.ext.picklepersistence.rst index ffd65a20302..0e62ecc6ac1 100644 --- a/docs/source/telegram.ext.picklepersistence.rst +++ b/docs/source/telegram.ext.picklepersistence.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PicklePersistence ================= -.. autoclass:: telegram.ext.PicklePersistence +.. currentmodule:: telegram.ext + +.. autoclass:: PicklePersistence :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.pollanswerhandler.rst b/docs/source/telegram.ext.pollanswerhandler.rst index 3f215e52029..17f1fb67133 100644 --- a/docs/source/telegram.ext.pollanswerhandler.rst +++ b/docs/source/telegram.ext.pollanswerhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PollAnswerHandler ================= -.. autoclass:: telegram.ext.PollAnswerHandler +.. currentmodule:: telegram.ext + +.. autoclass:: PollAnswerHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.pollhandler.rst b/docs/source/telegram.ext.pollhandler.rst index 2f6c19f26a0..1e59f535b70 100644 --- a/docs/source/telegram.ext.pollhandler.rst +++ b/docs/source/telegram.ext.pollhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PollHandler =========== -.. autoclass:: telegram.ext.PollHandler +.. currentmodule:: telegram.ext + +.. autoclass:: PollHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.precheckoutqueryhandler.rst b/docs/source/telegram.ext.precheckoutqueryhandler.rst index 482cba07b34..4b98f1bed2f 100644 --- a/docs/source/telegram.ext.precheckoutqueryhandler.rst +++ b/docs/source/telegram.ext.precheckoutqueryhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PreCheckoutQueryHandler ======================= -.. autoclass:: telegram.ext.PreCheckoutQueryHandler +.. currentmodule:: telegram.ext + +.. autoclass:: PreCheckoutQueryHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.prefixhandler.rst b/docs/source/telegram.ext.prefixhandler.rst index ad76838520a..13ef3389f61 100644 --- a/docs/source/telegram.ext.prefixhandler.rst +++ b/docs/source/telegram.ext.prefixhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PrefixHandler ============= -.. autoclass:: telegram.ext.PrefixHandler +.. currentmodule:: telegram.ext + +.. autoclass:: PrefixHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.rate-limiting-tree.rst b/docs/source/telegram.ext.rate-limiting-tree.rst index 023a3a633c5..4fa343eec74 100644 --- a/docs/source/telegram.ext.rate-limiting-tree.rst +++ b/docs/source/telegram.ext.rate-limiting-tree.rst @@ -1,8 +1,6 @@ -Rate Limiting -------------- +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _rate-limiting-tree: - telegram.ext.baseratelimiter - telegram.ext.aioratelimiter \ No newline at end of file +Rate Limiting +------------- diff --git a/docs/source/telegram.ext.rst b/docs/source/telegram.ext.rst index ab9efc1b353..596d1e20327 100644 --- a/docs/source/telegram.ext.rst +++ b/docs/source/telegram.ext.rst @@ -1,24 +1,3 @@ -telegram.ext package -==================== +.. Autogenerated page: True -.. automodule:: telegram.ext - -.. toctree:: - :titlesonly: - - telegram.ext.application - telegram.ext.applicationbuilder - telegram.ext.applicationhandlerstop - telegram.ext.baseupdateprocessor - telegram.ext.callbackcontext - telegram.ext.contexttypes - telegram.ext.defaults - telegram.ext.extbot - telegram.ext.job - telegram.ext.jobqueue - telegram.ext.simpleupdateprocessor - telegram.ext.updater - telegram.ext.handlers-tree.rst - telegram.ext.persistence-tree.rst - telegram.ext.acd-tree.rst - telegram.ext.rate-limiting-tree.rst \ No newline at end of file +.. include:: telegram/ext/index.rst diff --git a/docs/source/telegram.ext.shippingqueryhandler.rst b/docs/source/telegram.ext.shippingqueryhandler.rst index f368630fd38..9ddff31010a 100644 --- a/docs/source/telegram.ext.shippingqueryhandler.rst +++ b/docs/source/telegram.ext.shippingqueryhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ShippingQueryHandler ==================== -.. autoclass:: telegram.ext.ShippingQueryHandler +.. currentmodule:: telegram.ext + +.. autoclass:: ShippingQueryHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.simpleupdateprocessor.rst b/docs/source/telegram.ext.simpleupdateprocessor.rst index 1e30c27566c..3bba89c3992 100644 --- a/docs/source/telegram.ext.simpleupdateprocessor.rst +++ b/docs/source/telegram.ext.simpleupdateprocessor.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SimpleUpdateProcessor ===================== -.. autoclass:: telegram.ext.SimpleUpdateProcessor +.. currentmodule:: telegram.ext + +.. autoclass:: SimpleUpdateProcessor :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.stringcommandhandler.rst b/docs/source/telegram.ext.stringcommandhandler.rst index c716753ef11..1647c519180 100644 --- a/docs/source/telegram.ext.stringcommandhandler.rst +++ b/docs/source/telegram.ext.stringcommandhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StringCommandHandler ==================== -.. autoclass:: telegram.ext.StringCommandHandler +.. currentmodule:: telegram.ext + +.. autoclass:: StringCommandHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.stringregexhandler.rst b/docs/source/telegram.ext.stringregexhandler.rst index d8d8ef025f6..2b1eec653cf 100644 --- a/docs/source/telegram.ext.stringregexhandler.rst +++ b/docs/source/telegram.ext.stringregexhandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StringRegexHandler ================== -.. autoclass:: telegram.ext.StringRegexHandler +.. currentmodule:: telegram.ext + +.. autoclass:: StringRegexHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.typehandler.rst b/docs/source/telegram.ext.typehandler.rst index a85dd0f191c..b8097a49ef5 100644 --- a/docs/source/telegram.ext.typehandler.rst +++ b/docs/source/telegram.ext.typehandler.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TypeHandler =========== -.. autoclass:: telegram.ext.TypeHandler +.. currentmodule:: telegram.ext + +.. autoclass:: TypeHandler :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.updater.rst b/docs/source/telegram.ext.updater.rst index 642ddd20209..a2f24a67706 100644 --- a/docs/source/telegram.ext.updater.rst +++ b/docs/source/telegram.ext.updater.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Updater ======= -.. autoclass:: telegram.ext.Updater +.. currentmodule:: telegram.ext + +.. autoclass:: Updater :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.externalreplyinfo.rst b/docs/source/telegram.externalreplyinfo.rst index 568bf07ef38..acc2b1fa833 100644 --- a/docs/source/telegram.externalreplyinfo.rst +++ b/docs/source/telegram.externalreplyinfo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ExternalReplyInfo ================= -.. autoclass:: telegram.ExternalReplyInfo +.. currentmodule:: telegram + +.. autoclass:: ExternalReplyInfo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.file.rst b/docs/source/telegram.file.rst index 479474678dc..a371b63255d 100644 --- a/docs/source/telegram.file.rst +++ b/docs/source/telegram.file.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + File ==== -.. autoclass:: telegram.File +.. currentmodule:: telegram + +.. autoclass:: File :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.filecredentials.rst b/docs/source/telegram.filecredentials.rst index b82338ce7e6..c8ad2e2c711 100644 --- a/docs/source/telegram.filecredentials.rst +++ b/docs/source/telegram.filecredentials.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + FileCredentials =============== -.. autoclass:: telegram.FileCredentials +.. currentmodule:: telegram + +.. autoclass:: FileCredentials :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forcereply.rst b/docs/source/telegram.forcereply.rst index 8418d56f1aa..ca8d3f3a6d0 100644 --- a/docs/source/telegram.forcereply.rst +++ b/docs/source/telegram.forcereply.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ForceReply ========== -.. autoclass:: telegram.ForceReply +.. currentmodule:: telegram + +.. autoclass:: ForceReply :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopic.rst b/docs/source/telegram.forumtopic.rst index ba2ceb3a4df..c9e1d6fee66 100644 --- a/docs/source/telegram.forumtopic.rst +++ b/docs/source/telegram.forumtopic.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ForumTopic ========== -.. autoclass:: telegram.ForumTopic +.. currentmodule:: telegram + +.. autoclass:: ForumTopic :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopicclosed.rst b/docs/source/telegram.forumtopicclosed.rst index 1954cc4e078..c58d7ece2c8 100644 --- a/docs/source/telegram.forumtopicclosed.rst +++ b/docs/source/telegram.forumtopicclosed.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ForumTopicClosed ================ -.. autoclass:: telegram.ForumTopicClosed +.. currentmodule:: telegram + +.. autoclass:: ForumTopicClosed :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopiccreated.rst b/docs/source/telegram.forumtopiccreated.rst index 828aacee88f..bae5d36e643 100644 --- a/docs/source/telegram.forumtopiccreated.rst +++ b/docs/source/telegram.forumtopiccreated.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ForumTopicCreated ================= -.. autoclass:: telegram.ForumTopicCreated +.. currentmodule:: telegram + +.. autoclass:: ForumTopicCreated :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopicedited.rst b/docs/source/telegram.forumtopicedited.rst index 1b0a09a4868..8558192a876 100644 --- a/docs/source/telegram.forumtopicedited.rst +++ b/docs/source/telegram.forumtopicedited.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ForumTopicEdited ================ -.. autoclass:: telegram.ForumTopicEdited +.. currentmodule:: telegram + +.. autoclass:: ForumTopicEdited :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopicreopened.rst b/docs/source/telegram.forumtopicreopened.rst index d1e021865ba..d59faf1d020 100644 --- a/docs/source/telegram.forumtopicreopened.rst +++ b/docs/source/telegram.forumtopicreopened.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ForumTopicReopened ================== -.. autoclass:: telegram.ForumTopicReopened +.. currentmodule:: telegram + +.. autoclass:: ForumTopicReopened :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.game.rst b/docs/source/telegram.game.rst index 53f55489f2f..8d63e397b7b 100644 --- a/docs/source/telegram.game.rst +++ b/docs/source/telegram.game.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Game ==== -.. autoclass:: telegram.Game +.. currentmodule:: telegram + +.. autoclass:: Game :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.gamehighscore.rst b/docs/source/telegram.gamehighscore.rst index 784e4dd3a8c..1eab394280d 100644 --- a/docs/source/telegram.gamehighscore.rst +++ b/docs/source/telegram.gamehighscore.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + GameHighScore ============= -.. autoclass:: telegram.GameHighScore +.. currentmodule:: telegram + +.. autoclass:: GameHighScore :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.games-tree.rst b/docs/source/telegram.games-tree.rst index 97b961a9e85..6eb3fb04d9e 100644 --- a/docs/source/telegram.games-tree.rst +++ b/docs/source/telegram.games-tree.rst @@ -1,24 +1,6 @@ +.. Autogenerated page: True + .. _games-tree: Games ----- - -Your bot can offer users **HTML5 games** to play solo or to compete against each other in groups and one-on-one chats. Create games via `@BotFather `_ using the ``/newgame`` command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering. - -* Games are a new type of content on Telegram, represented by the :class:`telegram.Game` and :class:`telegram.InlineQueryResultGame` objects. -* Once you've created a game via `BotFather `_, you can send games to chats as regular messages using the :meth:`~telegram.Bot.sendGame` method, or use :ref:`inline mode ` with :class:`telegram.InlineQueryResultGame`. -* If you send the game message without any buttons, it will automatically have a 'Play ``GameName``' button. When this button is pressed, your bot gets a :class:`telegram.CallbackQuery` with the ``game_short_name`` of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser. -* You can manually add multiple buttons to your game message. Please note that the first button in the first row **must always** launch the game, using the field ``callback_game`` in :class:`telegram.InlineKeyboardButton`. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community. -* To make your game more attractive, you can upload a GIF animation that demonstrates the game to the users via `BotFather `_ (see `Lumberjack `_ for example). -* A game message will also display high scores for the current chat. Use :meth:`~telegram.Bot.setGameScore` to post high scores to the chat with the game, add the :paramref:`~telegram.Bot.set_game_score.disable_edit_message` parameter to disable automatic update of the message with the current scoreboard. -* Use :meth:`~telegram.Bot.getGameHighScores` to get data for in-game high score tables. -* You can also add an extra sharing button for users to share their best score to different chats. -* For examples of what can be done using this new stuff, check the `@gamebot `_ and `@gamee `_ bots. - - -.. toctree:: - :titlesonly: - - telegram.callbackgame - telegram.game - telegram.gamehighscore diff --git a/docs/source/telegram.generalforumtopichidden.rst b/docs/source/telegram.generalforumtopichidden.rst index 5d70e782f1a..5ab7ab47ebd 100644 --- a/docs/source/telegram.generalforumtopichidden.rst +++ b/docs/source/telegram.generalforumtopichidden.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + GeneralForumTopicHidden ======================= -.. autoclass:: telegram.GeneralForumTopicHidden +.. currentmodule:: telegram + +.. autoclass:: GeneralForumTopicHidden :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.generalforumtopicunhidden.rst b/docs/source/telegram.generalforumtopicunhidden.rst index ee82c770b99..9125917b840 100644 --- a/docs/source/telegram.generalforumtopicunhidden.rst +++ b/docs/source/telegram.generalforumtopicunhidden.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + GeneralForumTopicUnhidden ========================= -.. autoclass:: telegram.GeneralForumTopicUnhidden +.. currentmodule:: telegram + +.. autoclass:: GeneralForumTopicUnhidden :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.gift.rst b/docs/source/telegram.gift.rst index e42cb720ac2..0c343d090c7 100644 --- a/docs/source/telegram.gift.rst +++ b/docs/source/telegram.gift.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Gift ==== -.. autoclass:: telegram.Gift +.. currentmodule:: telegram + +.. autoclass:: Gift :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giftbackground.rst b/docs/source/telegram.giftbackground.rst index c2785ff67b0..bbc5bf04015 100644 --- a/docs/source/telegram.giftbackground.rst +++ b/docs/source/telegram.giftbackground.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + GiftBackground ============== -.. autoclass:: telegram.GiftBackground - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: GiftBackground + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giftinfo.rst b/docs/source/telegram.giftinfo.rst index ff5ab6ad352..08fb58fba0f 100644 --- a/docs/source/telegram.giftinfo.rst +++ b/docs/source/telegram.giftinfo.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + GiftInfo ======== -.. autoclass:: telegram.GiftInfo - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: GiftInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.gifts.rst b/docs/source/telegram.gifts.rst index 649522d0dce..6a8c1a8b5d4 100644 --- a/docs/source/telegram.gifts.rst +++ b/docs/source/telegram.gifts.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Gifts ===== -.. autoclass:: telegram.Gifts +.. currentmodule:: telegram + +.. autoclass:: Gifts :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveaway.rst b/docs/source/telegram.giveaway.rst index 8d1d854985a..bb2ce325ac9 100644 --- a/docs/source/telegram.giveaway.rst +++ b/docs/source/telegram.giveaway.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Giveaway ======== -.. autoclass:: telegram.Giveaway +.. currentmodule:: telegram + +.. autoclass:: Giveaway :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaycompleted.rst b/docs/source/telegram.giveawaycompleted.rst index c89e9564e85..0ac849d019b 100644 --- a/docs/source/telegram.giveawaycompleted.rst +++ b/docs/source/telegram.giveawaycompleted.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + GiveawayCompleted ================= -.. autoclass:: telegram.GiveawayCompleted +.. currentmodule:: telegram + +.. autoclass:: GiveawayCompleted :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaycreated.rst b/docs/source/telegram.giveawaycreated.rst index f29de887751..ef881bb72fd 100644 --- a/docs/source/telegram.giveawaycreated.rst +++ b/docs/source/telegram.giveawaycreated.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + GiveawayCreated =============== -.. autoclass:: telegram.GiveawayCreated +.. currentmodule:: telegram + +.. autoclass:: GiveawayCreated :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaywinners.rst b/docs/source/telegram.giveawaywinners.rst index 4be51e8502b..c52233349dd 100644 --- a/docs/source/telegram.giveawaywinners.rst +++ b/docs/source/telegram.giveawaywinners.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + GiveawayWinners =============== -.. autoclass:: telegram.GiveawayWinners +.. currentmodule:: telegram + +.. autoclass:: GiveawayWinners :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.helpers.rst b/docs/source/telegram.helpers.rst index 7d589f3e346..044ec094859 100644 --- a/docs/source/telegram.helpers.rst +++ b/docs/source/telegram.helpers.rst @@ -1,6 +1,3 @@ -telegram.helpers Module -======================= +.. Autogenerated page: True -.. automodule:: telegram.helpers - :members: - :show-inheritance: +.. include:: telegram/helpers.rst diff --git a/docs/source/telegram.iddocumentdata.rst b/docs/source/telegram.iddocumentdata.rst index 999d23bcc87..f0cf234c23c 100644 --- a/docs/source/telegram.iddocumentdata.rst +++ b/docs/source/telegram.iddocumentdata.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + IdDocumentData ============== -.. autoclass:: telegram.IdDocumentData +.. currentmodule:: telegram + +.. autoclass:: IdDocumentData :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inaccessiblemessage.rst b/docs/source/telegram.inaccessiblemessage.rst index d65c8c42c71..b94a650bcf9 100644 --- a/docs/source/telegram.inaccessiblemessage.rst +++ b/docs/source/telegram.inaccessiblemessage.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InaccessibleMessage =================== -.. autoclass:: telegram.InaccessibleMessage +.. currentmodule:: telegram + +.. autoclass:: InaccessibleMessage :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inline-tree.rst b/docs/source/telegram.inline-tree.rst index c21b3c33828..bafca573f3c 100644 --- a/docs/source/telegram.inline-tree.rst +++ b/docs/source/telegram.inline-tree.rst @@ -1,45 +1,6 @@ +.. Autogenerated page: True + .. _inline-tree: Inline Mode ----------- - -The following methods and objects allow your bot to work in `inline mode `_. -Please see Telegrams `Introduction to Inline bots `_ for more details. - -To enable this option, send the ``/setinline`` command to `@BotFather `_ and provide the placeholder text that the user will see in the input field after typing your bot's name. - - -.. toctree:: - :titlesonly: - - telegram.choseninlineresult - telegram.inlinequery - telegram.inlinequeryresult - telegram.inlinequeryresultarticle - telegram.inlinequeryresultaudio - telegram.inlinequeryresultcachedaudio - telegram.inlinequeryresultcacheddocument - telegram.inlinequeryresultcachedgif - telegram.inlinequeryresultcachedmpeg4gif - telegram.inlinequeryresultcachedphoto - telegram.inlinequeryresultcachedsticker - telegram.inlinequeryresultcachedvideo - telegram.inlinequeryresultcachedvoice - telegram.inlinequeryresultcontact - telegram.inlinequeryresultdocument - telegram.inlinequeryresultgame - telegram.inlinequeryresultgif - telegram.inlinequeryresultlocation - telegram.inlinequeryresultmpeg4gif - telegram.inlinequeryresultphoto - telegram.inlinequeryresultsbutton - telegram.inlinequeryresultvenue - telegram.inlinequeryresultvideo - telegram.inlinequeryresultvoice - telegram.inputmessagecontent - telegram.inputtextmessagecontent - telegram.inputlocationmessagecontent - telegram.inputvenuemessagecontent - telegram.inputcontactmessagecontent - telegram.inputinvoicemessagecontent - telegram.preparedinlinemessage diff --git a/docs/source/telegram.inlinekeyboardbutton.rst b/docs/source/telegram.inlinekeyboardbutton.rst index ff61d6fb400..d15ee562d4d 100644 --- a/docs/source/telegram.inlinekeyboardbutton.rst +++ b/docs/source/telegram.inlinekeyboardbutton.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineKeyboardButton ==================== -.. autoclass:: telegram.InlineKeyboardButton +.. currentmodule:: telegram + +.. autoclass:: InlineKeyboardButton :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinekeyboardmarkup.rst b/docs/source/telegram.inlinekeyboardmarkup.rst index 99a44cc9e39..ec02dc44393 100644 --- a/docs/source/telegram.inlinekeyboardmarkup.rst +++ b/docs/source/telegram.inlinekeyboardmarkup.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineKeyboardMarkup ==================== -.. autoclass:: telegram.InlineKeyboardMarkup +.. currentmodule:: telegram + +.. autoclass:: InlineKeyboardMarkup :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequery.rst b/docs/source/telegram.inlinequery.rst index eb806aa3876..9430c7b15ad 100644 --- a/docs/source/telegram.inlinequery.rst +++ b/docs/source/telegram.inlinequery.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQuery =========== -.. autoclass:: telegram.InlineQuery +.. currentmodule:: telegram + +.. autoclass:: InlineQuery :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresult.rst b/docs/source/telegram.inlinequeryresult.rst index eda58f1c245..ddd5092fb38 100644 --- a/docs/source/telegram.inlinequeryresult.rst +++ b/docs/source/telegram.inlinequeryresult.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResult ================= -.. autoclass:: telegram.InlineQueryResult +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResult :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultarticle.rst b/docs/source/telegram.inlinequeryresultarticle.rst index 1600c05903f..c58a9265f1b 100644 --- a/docs/source/telegram.inlinequeryresultarticle.rst +++ b/docs/source/telegram.inlinequeryresultarticle.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultArticle ======================== -.. autoclass:: telegram.InlineQueryResultArticle +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultArticle :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultaudio.rst b/docs/source/telegram.inlinequeryresultaudio.rst index a78399b0025..b54408546f0 100644 --- a/docs/source/telegram.inlinequeryresultaudio.rst +++ b/docs/source/telegram.inlinequeryresultaudio.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultAudio ====================== -.. autoclass:: telegram.InlineQueryResultAudio +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultAudio :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedaudio.rst b/docs/source/telegram.inlinequeryresultcachedaudio.rst index 860b7a4edb3..eadecb2afc4 100644 --- a/docs/source/telegram.inlinequeryresultcachedaudio.rst +++ b/docs/source/telegram.inlinequeryresultcachedaudio.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultCachedAudio ============================ -.. autoclass:: telegram.InlineQueryResultCachedAudio +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedAudio :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcacheddocument.rst b/docs/source/telegram.inlinequeryresultcacheddocument.rst index 6768b75210c..930fd0b5068 100644 --- a/docs/source/telegram.inlinequeryresultcacheddocument.rst +++ b/docs/source/telegram.inlinequeryresultcacheddocument.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultCachedDocument =============================== -.. autoclass:: telegram.InlineQueryResultCachedDocument +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedDocument :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedgif.rst b/docs/source/telegram.inlinequeryresultcachedgif.rst index c0b2f627779..75352cd6a32 100644 --- a/docs/source/telegram.inlinequeryresultcachedgif.rst +++ b/docs/source/telegram.inlinequeryresultcachedgif.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultCachedGif ========================== -.. autoclass:: telegram.InlineQueryResultCachedGif +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedGif :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst index 780fca432b4..d07276c9f33 100644 --- a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst +++ b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultCachedMpeg4Gif =============================== -.. autoclass:: telegram.InlineQueryResultCachedMpeg4Gif +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedMpeg4Gif :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedphoto.rst b/docs/source/telegram.inlinequeryresultcachedphoto.rst index 8a5b1bc4bfb..6f06251f9e2 100644 --- a/docs/source/telegram.inlinequeryresultcachedphoto.rst +++ b/docs/source/telegram.inlinequeryresultcachedphoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultCachedPhoto ============================ -.. autoclass:: telegram.InlineQueryResultCachedPhoto +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedPhoto :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedsticker.rst b/docs/source/telegram.inlinequeryresultcachedsticker.rst index eb204cb88df..35b2e561c64 100644 --- a/docs/source/telegram.inlinequeryresultcachedsticker.rst +++ b/docs/source/telegram.inlinequeryresultcachedsticker.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultCachedSticker ============================== -.. autoclass:: telegram.InlineQueryResultCachedSticker +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedSticker :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedvideo.rst b/docs/source/telegram.inlinequeryresultcachedvideo.rst index 121d5b95b08..83debd172fd 100644 --- a/docs/source/telegram.inlinequeryresultcachedvideo.rst +++ b/docs/source/telegram.inlinequeryresultcachedvideo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultCachedVideo ============================ -.. autoclass:: telegram.InlineQueryResultCachedVideo +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedVideo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedvoice.rst b/docs/source/telegram.inlinequeryresultcachedvoice.rst index dbe132af190..07b2f09500a 100644 --- a/docs/source/telegram.inlinequeryresultcachedvoice.rst +++ b/docs/source/telegram.inlinequeryresultcachedvoice.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultCachedVoice ============================ -.. autoclass:: telegram.InlineQueryResultCachedVoice +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedVoice :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcontact.rst b/docs/source/telegram.inlinequeryresultcontact.rst index 3fee7ac4e37..025ce2d4d5e 100644 --- a/docs/source/telegram.inlinequeryresultcontact.rst +++ b/docs/source/telegram.inlinequeryresultcontact.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultContact ======================== -.. autoclass:: telegram.InlineQueryResultContact +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultContact :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultdocument.rst b/docs/source/telegram.inlinequeryresultdocument.rst index 914fc0c0df2..eeb2105c12c 100644 --- a/docs/source/telegram.inlinequeryresultdocument.rst +++ b/docs/source/telegram.inlinequeryresultdocument.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultDocument ========================= -.. autoclass:: telegram.InlineQueryResultDocument +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultDocument :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultgame.rst b/docs/source/telegram.inlinequeryresultgame.rst index 8c3189c8179..89228a19825 100644 --- a/docs/source/telegram.inlinequeryresultgame.rst +++ b/docs/source/telegram.inlinequeryresultgame.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultGame ===================== -.. autoclass:: telegram.InlineQueryResultGame +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultGame :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultgif.rst b/docs/source/telegram.inlinequeryresultgif.rst index c19a9f79024..4d296b839cc 100644 --- a/docs/source/telegram.inlinequeryresultgif.rst +++ b/docs/source/telegram.inlinequeryresultgif.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultGif ==================== -.. autoclass:: telegram.InlineQueryResultGif +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultGif :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultlocation.rst b/docs/source/telegram.inlinequeryresultlocation.rst index 053bb74f00c..cbcee96c04d 100644 --- a/docs/source/telegram.inlinequeryresultlocation.rst +++ b/docs/source/telegram.inlinequeryresultlocation.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultLocation ========================= -.. autoclass:: telegram.InlineQueryResultLocation +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultLocation :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultmpeg4gif.rst b/docs/source/telegram.inlinequeryresultmpeg4gif.rst index 6e6d68bf725..36dd1c8985a 100644 --- a/docs/source/telegram.inlinequeryresultmpeg4gif.rst +++ b/docs/source/telegram.inlinequeryresultmpeg4gif.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultMpeg4Gif ========================= -.. autoclass:: telegram.InlineQueryResultMpeg4Gif +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultMpeg4Gif :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultphoto.rst b/docs/source/telegram.inlinequeryresultphoto.rst index b7f4671cafc..5f24b70e867 100644 --- a/docs/source/telegram.inlinequeryresultphoto.rst +++ b/docs/source/telegram.inlinequeryresultphoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultPhoto ====================== -.. autoclass:: telegram.InlineQueryResultPhoto +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultPhoto :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultsbutton.rst b/docs/source/telegram.inlinequeryresultsbutton.rst index 7323a20cc60..36b034f38f4 100644 --- a/docs/source/telegram.inlinequeryresultsbutton.rst +++ b/docs/source/telegram.inlinequeryresultsbutton.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultsButton ======================== -.. autoclass:: telegram.InlineQueryResultsButton +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultsButton :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultvenue.rst b/docs/source/telegram.inlinequeryresultvenue.rst index 0c5f19b03ae..bcd89010140 100644 --- a/docs/source/telegram.inlinequeryresultvenue.rst +++ b/docs/source/telegram.inlinequeryresultvenue.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultVenue ====================== -.. autoclass:: telegram.InlineQueryResultVenue +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultVenue :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultvideo.rst b/docs/source/telegram.inlinequeryresultvideo.rst index 3df6d559ac1..799d69db0ef 100644 --- a/docs/source/telegram.inlinequeryresultvideo.rst +++ b/docs/source/telegram.inlinequeryresultvideo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultVideo ====================== -.. autoclass:: telegram.InlineQueryResultVideo +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultVideo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultvoice.rst b/docs/source/telegram.inlinequeryresultvoice.rst index 8194b3ad62a..20c14e0406e 100644 --- a/docs/source/telegram.inlinequeryresultvoice.rst +++ b/docs/source/telegram.inlinequeryresultvoice.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InlineQueryResultVoice ====================== -.. autoclass:: telegram.InlineQueryResultVoice +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultVoice :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputchecklist.rst b/docs/source/telegram.inputchecklist.rst index f83345884a0..8d7acaf336e 100644 --- a/docs/source/telegram.inputchecklist.rst +++ b/docs/source/telegram.inputchecklist.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputChecklist ============== -.. autoclass:: telegram.InputChecklist +.. currentmodule:: telegram + +.. autoclass:: InputChecklist :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputchecklisttask.rst b/docs/source/telegram.inputchecklisttask.rst index 1cc14095b0c..2c02012bc90 100644 --- a/docs/source/telegram.inputchecklisttask.rst +++ b/docs/source/telegram.inputchecklisttask.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputChecklistTask ================== -.. autoclass:: telegram.InputChecklistTask +.. currentmodule:: telegram + +.. autoclass:: InputChecklistTask :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputcontactmessagecontent.rst b/docs/source/telegram.inputcontactmessagecontent.rst index 5deb70724d4..94d58bd79c4 100644 --- a/docs/source/telegram.inputcontactmessagecontent.rst +++ b/docs/source/telegram.inputcontactmessagecontent.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputContactMessageContent ========================== -.. autoclass:: telegram.InputContactMessageContent +.. currentmodule:: telegram + +.. autoclass:: InputContactMessageContent :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputfile.rst b/docs/source/telegram.inputfile.rst index 717f9235a9f..0afd886ccd0 100644 --- a/docs/source/telegram.inputfile.rst +++ b/docs/source/telegram.inputfile.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputFile ========= -.. autoclass:: telegram.InputFile +.. currentmodule:: telegram + +.. autoclass:: InputFile :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputinvoicemessagecontent.rst b/docs/source/telegram.inputinvoicemessagecontent.rst index 0354229e76f..cea1ffca1e8 100644 --- a/docs/source/telegram.inputinvoicemessagecontent.rst +++ b/docs/source/telegram.inputinvoicemessagecontent.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputInvoiceMessageContent ========================== -.. autoclass:: telegram.InputInvoiceMessageContent +.. currentmodule:: telegram + +.. autoclass:: InputInvoiceMessageContent :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputlocationmessagecontent.rst b/docs/source/telegram.inputlocationmessagecontent.rst index 51359967ce4..f0ea03bc822 100644 --- a/docs/source/telegram.inputlocationmessagecontent.rst +++ b/docs/source/telegram.inputlocationmessagecontent.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputLocationMessageContent =========================== -.. autoclass:: telegram.InputLocationMessageContent +.. currentmodule:: telegram + +.. autoclass:: InputLocationMessageContent :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmedia.rst b/docs/source/telegram.inputmedia.rst index 4f58bbb0e5a..c67a046c9e1 100644 --- a/docs/source/telegram.inputmedia.rst +++ b/docs/source/telegram.inputmedia.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMedia ========== -.. autoclass:: telegram.InputMedia +.. currentmodule:: telegram + +.. autoclass:: InputMedia :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediaanimation.rst b/docs/source/telegram.inputmediaanimation.rst index 4324182d7d0..c6db3fef122 100644 --- a/docs/source/telegram.inputmediaanimation.rst +++ b/docs/source/telegram.inputmediaanimation.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaAnimation =================== -.. autoclass:: telegram.InputMediaAnimation +.. currentmodule:: telegram + +.. autoclass:: InputMediaAnimation :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediaaudio.rst b/docs/source/telegram.inputmediaaudio.rst index f91484ed3c9..1e3c37f3ef2 100644 --- a/docs/source/telegram.inputmediaaudio.rst +++ b/docs/source/telegram.inputmediaaudio.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaAudio =============== -.. autoclass:: telegram.InputMediaAudio +.. currentmodule:: telegram + +.. autoclass:: InputMediaAudio :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediadocument.rst b/docs/source/telegram.inputmediadocument.rst index e6681a73b32..c5381a3399b 100644 --- a/docs/source/telegram.inputmediadocument.rst +++ b/docs/source/telegram.inputmediadocument.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaDocument ================== -.. autoclass:: telegram.InputMediaDocument +.. currentmodule:: telegram + +.. autoclass:: InputMediaDocument :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmedialivephoto.rst b/docs/source/telegram.inputmedialivephoto.rst index 975614554a1..179f62c7614 100644 --- a/docs/source/telegram.inputmedialivephoto.rst +++ b/docs/source/telegram.inputmedialivephoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaLivePhoto =================== -.. autoclass:: telegram.InputMediaLivePhoto +.. currentmodule:: telegram + +.. autoclass:: InputMediaLivePhoto :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmedialocation.rst b/docs/source/telegram.inputmedialocation.rst index aa20d631ea4..bc5a5abf728 100644 --- a/docs/source/telegram.inputmedialocation.rst +++ b/docs/source/telegram.inputmedialocation.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaLocation ================== -.. autoclass:: telegram.InputMediaLocation +.. currentmodule:: telegram + +.. autoclass:: InputMediaLocation :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediaphoto.rst b/docs/source/telegram.inputmediaphoto.rst index ad7091fe7e0..e735a040b61 100644 --- a/docs/source/telegram.inputmediaphoto.rst +++ b/docs/source/telegram.inputmediaphoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaPhoto =============== -.. autoclass:: telegram.InputMediaPhoto +.. currentmodule:: telegram + +.. autoclass:: InputMediaPhoto :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediasticker.rst b/docs/source/telegram.inputmediasticker.rst index 7f2b6d7778e..cfb70d3b376 100644 --- a/docs/source/telegram.inputmediasticker.rst +++ b/docs/source/telegram.inputmediasticker.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaSticker ================= -.. autoclass:: telegram.InputMediaSticker +.. currentmodule:: telegram + +.. autoclass:: InputMediaSticker :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediavenue.rst b/docs/source/telegram.inputmediavenue.rst index e5e221e2f73..898fa27bebd 100644 --- a/docs/source/telegram.inputmediavenue.rst +++ b/docs/source/telegram.inputmediavenue.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaVenue =============== -.. autoclass:: telegram.InputMediaVenue +.. currentmodule:: telegram + +.. autoclass:: InputMediaVenue :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediavideo.rst b/docs/source/telegram.inputmediavideo.rst index 751261c4804..2d6038999cc 100644 --- a/docs/source/telegram.inputmediavideo.rst +++ b/docs/source/telegram.inputmediavideo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMediaVideo =============== -.. autoclass:: telegram.InputMediaVideo +.. currentmodule:: telegram + +.. autoclass:: InputMediaVideo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmessagecontent.rst b/docs/source/telegram.inputmessagecontent.rst index a7b50b5b488..f4a1694abe3 100644 --- a/docs/source/telegram.inputmessagecontent.rst +++ b/docs/source/telegram.inputmessagecontent.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputMessageContent =================== -.. autoclass:: telegram.InputMessageContent +.. currentmodule:: telegram + +.. autoclass:: InputMessageContent :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmedia.rst b/docs/source/telegram.inputpaidmedia.rst index ecb45d35f6d..216242efb71 100644 --- a/docs/source/telegram.inputpaidmedia.rst +++ b/docs/source/telegram.inputpaidmedia.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputPaidMedia ============== -.. autoclass:: telegram.InputPaidMedia +.. currentmodule:: telegram + +.. autoclass:: InputPaidMedia :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmedialivephoto.rst b/docs/source/telegram.inputpaidmedialivephoto.rst index 62bf1a2dac6..0e2c905514b 100644 --- a/docs/source/telegram.inputpaidmedialivephoto.rst +++ b/docs/source/telegram.inputpaidmedialivephoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputPaidMediaLivePhoto -====================== +======================= + +.. currentmodule:: telegram -.. autoclass:: telegram.InputPaidMediaLivePhoto +.. autoclass:: InputPaidMediaLivePhoto :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmediaphoto.rst b/docs/source/telegram.inputpaidmediaphoto.rst index f8df55823a2..a84522260f0 100644 --- a/docs/source/telegram.inputpaidmediaphoto.rst +++ b/docs/source/telegram.inputpaidmediaphoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputPaidMediaPhoto =================== -.. autoclass:: telegram.InputPaidMediaPhoto +.. currentmodule:: telegram + +.. autoclass:: InputPaidMediaPhoto :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmediavideo.rst b/docs/source/telegram.inputpaidmediavideo.rst index 8a3789f5028..bd718823c92 100644 --- a/docs/source/telegram.inputpaidmediavideo.rst +++ b/docs/source/telegram.inputpaidmediavideo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputPaidMediaVideo =================== -.. autoclass:: telegram.InputPaidMediaVideo +.. currentmodule:: telegram + +.. autoclass:: InputPaidMediaVideo :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpollmedia.rst b/docs/source/telegram.inputpollmedia.rst index 6178a00d4a4..a7d4b8b8814 100644 --- a/docs/source/telegram.inputpollmedia.rst +++ b/docs/source/telegram.inputpollmedia.rst @@ -1,6 +1,3 @@ -InputPollMedia -============== +.. Autogenerated page: True -.. versionadded:: NEXT.VERSION - -.. autoclass:: telegram.InputPollMedia +.. include:: telegram/inputpollmedia.rst diff --git a/docs/source/telegram.inputpolloption.rst b/docs/source/telegram.inputpolloption.rst index 51a2aab5a3b..8ece4a7b1a3 100644 --- a/docs/source/telegram.inputpolloption.rst +++ b/docs/source/telegram.inputpolloption.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputPollOption =============== -.. autoclass:: telegram.InputPollOption +.. currentmodule:: telegram + +.. autoclass:: InputPollOption :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpolloptionmedia.rst b/docs/source/telegram.inputpolloptionmedia.rst index 2af6693ad19..d1b204e5ff7 100644 --- a/docs/source/telegram.inputpolloptionmedia.rst +++ b/docs/source/telegram.inputpolloptionmedia.rst @@ -1,6 +1,3 @@ -InputPollOptionMedia -==================== +.. Autogenerated page: True -.. versionadded:: NEXT.VERSION - -.. autoclass:: telegram.InputPollOptionMedia +.. include:: telegram/inputpolloptionmedia.rst diff --git a/docs/source/telegram.inputprofilephoto.rst b/docs/source/telegram.inputprofilephoto.rst index 723f3c92389..4749d92ee07 100644 --- a/docs/source/telegram.inputprofilephoto.rst +++ b/docs/source/telegram.inputprofilephoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputProfilePhoto ================= -.. autoclass:: telegram.InputProfilePhoto +.. currentmodule:: telegram + +.. autoclass:: InputProfilePhoto :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputprofilephotoanimated.rst b/docs/source/telegram.inputprofilephotoanimated.rst index c192d0d8e58..eef7d390069 100644 --- a/docs/source/telegram.inputprofilephotoanimated.rst +++ b/docs/source/telegram.inputprofilephotoanimated.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputProfilePhotoAnimated ========================= -.. autoclass:: telegram.InputProfilePhotoAnimated +.. currentmodule:: telegram + +.. autoclass:: InputProfilePhotoAnimated :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputprofilephotostatic.rst b/docs/source/telegram.inputprofilephotostatic.rst index 49b498c13ba..e422fddf811 100644 --- a/docs/source/telegram.inputprofilephotostatic.rst +++ b/docs/source/telegram.inputprofilephotostatic.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputProfilePhotoStatic ======================= -.. autoclass:: telegram.InputProfilePhotoStatic +.. currentmodule:: telegram + +.. autoclass:: InputProfilePhotoStatic :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputsticker.rst b/docs/source/telegram.inputsticker.rst index f0dd593ae8b..6476b51e050 100644 --- a/docs/source/telegram.inputsticker.rst +++ b/docs/source/telegram.inputsticker.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputSticker ============ -.. autoclass:: telegram.InputSticker +.. currentmodule:: telegram + +.. autoclass:: InputSticker :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputstorycontent.rst b/docs/source/telegram.inputstorycontent.rst index 3406e8cf253..526121fc2a6 100644 --- a/docs/source/telegram.inputstorycontent.rst +++ b/docs/source/telegram.inputstorycontent.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputStoryContent ================= -.. autoclass:: telegram.InputStoryContent +.. currentmodule:: telegram + +.. autoclass:: InputStoryContent :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputstorycontentphoto.rst b/docs/source/telegram.inputstorycontentphoto.rst index 1adacb2322c..240fd17e548 100644 --- a/docs/source/telegram.inputstorycontentphoto.rst +++ b/docs/source/telegram.inputstorycontentphoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputStoryContentPhoto ====================== -.. autoclass:: telegram.InputStoryContentPhoto +.. currentmodule:: telegram + +.. autoclass:: InputStoryContentPhoto :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputstorycontentvideo.rst b/docs/source/telegram.inputstorycontentvideo.rst index 27550468e3b..50f6a61255c 100644 --- a/docs/source/telegram.inputstorycontentvideo.rst +++ b/docs/source/telegram.inputstorycontentvideo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputStoryContentVideo ====================== -.. autoclass:: telegram.InputStoryContentVideo +.. currentmodule:: telegram + +.. autoclass:: InputStoryContentVideo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputtextmessagecontent.rst b/docs/source/telegram.inputtextmessagecontent.rst index 652a6bef135..09e32231f9b 100644 --- a/docs/source/telegram.inputtextmessagecontent.rst +++ b/docs/source/telegram.inputtextmessagecontent.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputTextMessageContent ======================= -.. autoclass:: telegram.InputTextMessageContent +.. currentmodule:: telegram + +.. autoclass:: InputTextMessageContent :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputvenuemessagecontent.rst b/docs/source/telegram.inputvenuemessagecontent.rst index 678be16e654..e3f704cc726 100644 --- a/docs/source/telegram.inputvenuemessagecontent.rst +++ b/docs/source/telegram.inputvenuemessagecontent.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + InputVenueMessageContent ======================== -.. autoclass:: telegram.InputVenueMessageContent +.. currentmodule:: telegram + +.. autoclass:: InputVenueMessageContent :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.invoice.rst b/docs/source/telegram.invoice.rst index 0033452af7a..c9108d18615 100644 --- a/docs/source/telegram.invoice.rst +++ b/docs/source/telegram.invoice.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Invoice ======= -.. autoclass:: telegram.Invoice +.. currentmodule:: telegram + +.. autoclass:: Invoice :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbutton.rst b/docs/source/telegram.keyboardbutton.rst index ccc5ebb7c43..312930a7454 100644 --- a/docs/source/telegram.keyboardbutton.rst +++ b/docs/source/telegram.keyboardbutton.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + KeyboardButton ============== -.. autoclass:: telegram.KeyboardButton +.. currentmodule:: telegram + +.. autoclass:: KeyboardButton :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonpolltype.rst b/docs/source/telegram.keyboardbuttonpolltype.rst index 44d0d13e4e6..f1f6769fef2 100644 --- a/docs/source/telegram.keyboardbuttonpolltype.rst +++ b/docs/source/telegram.keyboardbuttonpolltype.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + KeyboardButtonPollType ====================== -.. autoclass:: telegram.KeyboardButtonPollType +.. currentmodule:: telegram + +.. autoclass:: KeyboardButtonPollType :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonrequestchat.rst b/docs/source/telegram.keyboardbuttonrequestchat.rst index d902b27c0d1..f23d0c3af04 100644 --- a/docs/source/telegram.keyboardbuttonrequestchat.rst +++ b/docs/source/telegram.keyboardbuttonrequestchat.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + KeyboardButtonRequestChat -================================== +========================= + +.. currentmodule:: telegram -.. autoclass:: telegram.KeyboardButtonRequestChat +.. autoclass:: KeyboardButtonRequestChat :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst b/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst index 2840249e15d..03e6a9c467c 100644 --- a/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst +++ b/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + KeyboardButtonRequestManagedBot =============================== -.. autoclass:: telegram.KeyboardButtonRequestManagedBot +.. currentmodule:: telegram + +.. autoclass:: KeyboardButtonRequestManagedBot :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonrequestusers.rst b/docs/source/telegram.keyboardbuttonrequestusers.rst index a56e9fb4316..0a0b9ba23ae 100644 --- a/docs/source/telegram.keyboardbuttonrequestusers.rst +++ b/docs/source/telegram.keyboardbuttonrequestusers.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + KeyboardButtonRequestUsers ========================== -.. autoclass:: telegram.KeyboardButtonRequestUsers +.. currentmodule:: telegram + +.. autoclass:: KeyboardButtonRequestUsers :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.labeledprice.rst b/docs/source/telegram.labeledprice.rst index 18ec28c0da9..a0d4d7e5ff4 100644 --- a/docs/source/telegram.labeledprice.rst +++ b/docs/source/telegram.labeledprice.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + LabeledPrice ============ -.. autoclass:: telegram.LabeledPrice +.. currentmodule:: telegram + +.. autoclass:: LabeledPrice :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.linkpreviewoptions.rst b/docs/source/telegram.linkpreviewoptions.rst index 53b46cdcf80..5f0132efaa0 100644 --- a/docs/source/telegram.linkpreviewoptions.rst +++ b/docs/source/telegram.linkpreviewoptions.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + LinkPreviewOptions ================== -.. autoclass:: telegram.LinkPreviewOptions +.. currentmodule:: telegram + +.. autoclass:: LinkPreviewOptions :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.livephoto.rst b/docs/source/telegram.livephoto.rst index 969e4b4db4c..97f6edaa4af 100644 --- a/docs/source/telegram.livephoto.rst +++ b/docs/source/telegram.livephoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + LivePhoto ========= -.. autoclass:: telegram.LivePhoto +.. currentmodule:: telegram + +.. autoclass:: LivePhoto :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.location.rst b/docs/source/telegram.location.rst index 5240b32477f..bdd1ce18cb2 100644 --- a/docs/source/telegram.location.rst +++ b/docs/source/telegram.location.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Location ======== -.. autoclass:: telegram.Location +.. currentmodule:: telegram + +.. autoclass:: Location :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.locationaddress.rst b/docs/source/telegram.locationaddress.rst index f6e3874de9d..08a3f901778 100644 --- a/docs/source/telegram.locationaddress.rst +++ b/docs/source/telegram.locationaddress.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + LocationAddress =============== -.. autoclass:: telegram.LocationAddress +.. currentmodule:: telegram + +.. autoclass:: LocationAddress :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.loginurl.rst b/docs/source/telegram.loginurl.rst index 382b44de51b..4e1bb1f723a 100644 --- a/docs/source/telegram.loginurl.rst +++ b/docs/source/telegram.loginurl.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + LoginUrl ======== -.. autoclass:: telegram.LoginUrl +.. currentmodule:: telegram + +.. autoclass:: LoginUrl :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.managedbotcreated.rst b/docs/source/telegram.managedbotcreated.rst index e137de86830..e3e10eb0019 100644 --- a/docs/source/telegram.managedbotcreated.rst +++ b/docs/source/telegram.managedbotcreated.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ManagedBotCreated ================= -.. autoclass:: telegram.ManagedBotCreated +.. currentmodule:: telegram + +.. autoclass:: ManagedBotCreated :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.managedbotupdated.rst b/docs/source/telegram.managedbotupdated.rst index f47bd6b60cc..0a897a1b0c8 100644 --- a/docs/source/telegram.managedbotupdated.rst +++ b/docs/source/telegram.managedbotupdated.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ManagedBotUpdated ================= -.. autoclass:: telegram.ManagedBotUpdated +.. currentmodule:: telegram + +.. autoclass:: ManagedBotUpdated :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.maskposition.rst b/docs/source/telegram.maskposition.rst index 469693dbe3a..f7eab72fd5d 100644 --- a/docs/source/telegram.maskposition.rst +++ b/docs/source/telegram.maskposition.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MaskPosition ============ -.. autoclass:: telegram.MaskPosition +.. currentmodule:: telegram + +.. autoclass:: MaskPosition :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.maybeinaccessiblemessage.rst b/docs/source/telegram.maybeinaccessiblemessage.rst index 920d757c487..446c7a7ce7c 100644 --- a/docs/source/telegram.maybeinaccessiblemessage.rst +++ b/docs/source/telegram.maybeinaccessiblemessage.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MaybeInaccessibleMessage ======================== -.. autoclass:: telegram.MaybeInaccessibleMessage +.. currentmodule:: telegram + +.. autoclass:: MaybeInaccessibleMessage :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubutton.rst b/docs/source/telegram.menubutton.rst index 63a0935b026..1bf079639ba 100644 --- a/docs/source/telegram.menubutton.rst +++ b/docs/source/telegram.menubutton.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MenuButton ========== -.. autoclass:: telegram.MenuButton +.. currentmodule:: telegram + +.. autoclass:: MenuButton :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttoncommands.rst b/docs/source/telegram.menubuttoncommands.rst index bc44e738f96..df7fb8b56c4 100644 --- a/docs/source/telegram.menubuttoncommands.rst +++ b/docs/source/telegram.menubuttoncommands.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MenuButtonCommands ================== -.. autoclass:: telegram.MenuButtonCommands +.. currentmodule:: telegram + +.. autoclass:: MenuButtonCommands :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttondefault.rst b/docs/source/telegram.menubuttondefault.rst index 31924b088fe..c69471b8cc2 100644 --- a/docs/source/telegram.menubuttondefault.rst +++ b/docs/source/telegram.menubuttondefault.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MenuButtonDefault ================= -.. autoclass:: telegram.MenuButtonDefault +.. currentmodule:: telegram + +.. autoclass:: MenuButtonDefault :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttonwebapp.rst b/docs/source/telegram.menubuttonwebapp.rst index 6eba96a239f..96a8443aded 100644 --- a/docs/source/telegram.menubuttonwebapp.rst +++ b/docs/source/telegram.menubuttonwebapp.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MenuButtonWebApp ================ -.. autoclass:: telegram.MenuButtonWebApp +.. currentmodule:: telegram + +.. autoclass:: MenuButtonWebApp :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.message.rst b/docs/source/telegram.message.rst index 83eea631455..0bac928bb29 100644 --- a/docs/source/telegram.message.rst +++ b/docs/source/telegram.message.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Message ======= -.. autoclass:: telegram.Message +.. currentmodule:: telegram + +.. autoclass:: Message :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageautodeletetimerchanged.rst b/docs/source/telegram.messageautodeletetimerchanged.rst index 69658f3c659..d9480cd6472 100644 --- a/docs/source/telegram.messageautodeletetimerchanged.rst +++ b/docs/source/telegram.messageautodeletetimerchanged.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageAutoDeleteTimerChanged ============================= -.. autoclass:: telegram.MessageAutoDeleteTimerChanged +.. currentmodule:: telegram + +.. autoclass:: MessageAutoDeleteTimerChanged :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageentity.rst b/docs/source/telegram.messageentity.rst index 1d669f0e7a5..6408be71e5d 100644 --- a/docs/source/telegram.messageentity.rst +++ b/docs/source/telegram.messageentity.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageEntity ============= -.. autoclass:: telegram.MessageEntity +.. currentmodule:: telegram + +.. autoclass:: MessageEntity :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageid.rst b/docs/source/telegram.messageid.rst index a4a7b8b16b2..590b475ba66 100644 --- a/docs/source/telegram.messageid.rst +++ b/docs/source/telegram.messageid.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageId ========= -.. autoclass:: telegram.MessageId +.. currentmodule:: telegram + +.. autoclass:: MessageId :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageorigin.rst b/docs/source/telegram.messageorigin.rst index ed0cf6905e2..e81fd14d00e 100644 --- a/docs/source/telegram.messageorigin.rst +++ b/docs/source/telegram.messageorigin.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageOrigin ============= -.. autoclass:: telegram.MessageOrigin +.. currentmodule:: telegram + +.. autoclass:: MessageOrigin :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageoriginchannel.rst b/docs/source/telegram.messageoriginchannel.rst index bddd957a3f3..f0763b3fbfd 100644 --- a/docs/source/telegram.messageoriginchannel.rst +++ b/docs/source/telegram.messageoriginchannel.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageOriginChannel ==================== -.. autoclass:: telegram.MessageOriginChannel +.. currentmodule:: telegram + +.. autoclass:: MessageOriginChannel :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageoriginchat.rst b/docs/source/telegram.messageoriginchat.rst index 928572446aa..19ae6c0e96b 100644 --- a/docs/source/telegram.messageoriginchat.rst +++ b/docs/source/telegram.messageoriginchat.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageOriginChat ================= -.. autoclass:: telegram.MessageOriginChat +.. currentmodule:: telegram + +.. autoclass:: MessageOriginChat :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageoriginhiddenuser.rst b/docs/source/telegram.messageoriginhiddenuser.rst index 7556a94f00c..53310942b30 100644 --- a/docs/source/telegram.messageoriginhiddenuser.rst +++ b/docs/source/telegram.messageoriginhiddenuser.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + MessageOriginHiddenUser ======================= -.. autoclass:: telegram.MessageOriginHiddenUser - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: MessageOriginHiddenUser + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageoriginuser.rst b/docs/source/telegram.messageoriginuser.rst index 365bb455d17..b71069cb03a 100644 --- a/docs/source/telegram.messageoriginuser.rst +++ b/docs/source/telegram.messageoriginuser.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageOriginUser ================= -.. autoclass:: telegram.MessageOriginUser +.. currentmodule:: telegram + +.. autoclass:: MessageOriginUser :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messagereactioncountupdated.rst b/docs/source/telegram.messagereactioncountupdated.rst index 4a0aead1e81..5acd94836e3 100644 --- a/docs/source/telegram.messagereactioncountupdated.rst +++ b/docs/source/telegram.messagereactioncountupdated.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageReactionCountUpdated =========================== -.. autoclass:: telegram.MessageReactionCountUpdated +.. currentmodule:: telegram + +.. autoclass:: MessageReactionCountUpdated :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messagereactionupdated.rst b/docs/source/telegram.messagereactionupdated.rst index 7110fb23fee..0c0a684bab1 100644 --- a/docs/source/telegram.messagereactionupdated.rst +++ b/docs/source/telegram.messagereactionupdated.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + MessageReactionUpdated ====================== -.. autoclass:: telegram.MessageReactionUpdated +.. currentmodule:: telegram + +.. autoclass:: MessageReactionUpdated :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.orderinfo.rst b/docs/source/telegram.orderinfo.rst index 4826a584f63..dab2aa21b47 100644 --- a/docs/source/telegram.orderinfo.rst +++ b/docs/source/telegram.orderinfo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + OrderInfo ========= -.. autoclass:: telegram.OrderInfo +.. currentmodule:: telegram + +.. autoclass:: OrderInfo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ownedgift.rst b/docs/source/telegram.ownedgift.rst index 0c726895c07..74e671698c0 100644 --- a/docs/source/telegram.ownedgift.rst +++ b/docs/source/telegram.ownedgift.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + OwnedGift ========= -.. autoclass:: telegram.OwnedGift +.. currentmodule:: telegram + +.. autoclass:: OwnedGift :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ownedgiftregular.rst b/docs/source/telegram.ownedgiftregular.rst index eb4f3641ed6..fc70761eba4 100644 --- a/docs/source/telegram.ownedgiftregular.rst +++ b/docs/source/telegram.ownedgiftregular.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + OwnedGiftRegular ================ -.. autoclass:: telegram.OwnedGiftRegular +.. currentmodule:: telegram + +.. autoclass:: OwnedGiftRegular :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ownedgifts.rst b/docs/source/telegram.ownedgifts.rst index 71a1c51b86f..0b3b343880a 100644 --- a/docs/source/telegram.ownedgifts.rst +++ b/docs/source/telegram.ownedgifts.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + OwnedGifts ========== -.. autoclass:: telegram.OwnedGifts +.. currentmodule:: telegram + +.. autoclass:: OwnedGifts :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ownedgiftunique.rst b/docs/source/telegram.ownedgiftunique.rst index cc114fecc49..5ae51f60db6 100644 --- a/docs/source/telegram.ownedgiftunique.rst +++ b/docs/source/telegram.ownedgiftunique.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + OwnedGiftUnique =============== -.. autoclass:: telegram.OwnedGiftUnique +.. currentmodule:: telegram + +.. autoclass:: OwnedGiftUnique :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmedia.rst b/docs/source/telegram.paidmedia.rst index 0883310f324..437139b7ab3 100644 --- a/docs/source/telegram.paidmedia.rst +++ b/docs/source/telegram.paidmedia.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMedia ========= -.. autoclass:: telegram.PaidMedia +.. currentmodule:: telegram + +.. autoclass:: PaidMedia :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediainfo.rst b/docs/source/telegram.paidmediainfo.rst index 3c0d1e75c52..5e7814f4436 100644 --- a/docs/source/telegram.paidmediainfo.rst +++ b/docs/source/telegram.paidmediainfo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMediaInfo ============= -.. autoclass:: telegram.PaidMediaInfo +.. currentmodule:: telegram + +.. autoclass:: PaidMediaInfo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmedialivephoto.rst b/docs/source/telegram.paidmedialivephoto.rst index 12fe8058ce9..b646cc66be9 100644 --- a/docs/source/telegram.paidmedialivephoto.rst +++ b/docs/source/telegram.paidmedialivephoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMediaLivePhoto ================== -.. autoclass:: telegram.PaidMediaLivePhoto +.. currentmodule:: telegram + +.. autoclass:: PaidMediaLivePhoto :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediaphoto.rst b/docs/source/telegram.paidmediaphoto.rst index 4092cfcc187..6b4ed55030a 100644 --- a/docs/source/telegram.paidmediaphoto.rst +++ b/docs/source/telegram.paidmediaphoto.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMediaPhoto ============== -.. autoclass:: telegram.PaidMediaPhoto +.. currentmodule:: telegram + +.. autoclass:: PaidMediaPhoto :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediapreview.rst b/docs/source/telegram.paidmediapreview.rst index 32ff4809d69..e25654b60ab 100644 --- a/docs/source/telegram.paidmediapreview.rst +++ b/docs/source/telegram.paidmediapreview.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMediaPreview ================ -.. autoclass:: telegram.PaidMediaPreview +.. currentmodule:: telegram + +.. autoclass:: PaidMediaPreview :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediapurchased.rst b/docs/source/telegram.paidmediapurchased.rst index 80568ae405c..12afaa94471 100644 --- a/docs/source/telegram.paidmediapurchased.rst +++ b/docs/source/telegram.paidmediapurchased.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMediaPurchased ================== -.. autoclass:: telegram.PaidMediaPurchased +.. currentmodule:: telegram + +.. autoclass:: PaidMediaPurchased :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediavideo.rst b/docs/source/telegram.paidmediavideo.rst index 30f2377ac86..a16bede8f37 100644 --- a/docs/source/telegram.paidmediavideo.rst +++ b/docs/source/telegram.paidmediavideo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMediaVideo ============== -.. autoclass:: telegram.PaidMediaVideo +.. currentmodule:: telegram + +.. autoclass:: PaidMediaVideo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmessagepricechanged.rst b/docs/source/telegram.paidmessagepricechanged.rst index 3d0e739c456..fc6beeab094 100644 --- a/docs/source/telegram.paidmessagepricechanged.rst +++ b/docs/source/telegram.paidmessagepricechanged.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PaidMessagePriceChanged ======================= -.. autoclass:: telegram.PaidMessagePriceChanged +.. currentmodule:: telegram + +.. autoclass:: PaidMessagePriceChanged :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passport-tree.rst b/docs/source/telegram.passport-tree.rst index 079ce948924..02cf34503c7 100644 --- a/docs/source/telegram.passport-tree.rst +++ b/docs/source/telegram.passport-tree.rst @@ -1,31 +1,6 @@ -Passport --------- - -Passport is a unified authorization method for services that require personal identification. Users can upload their documents once, then instantly share their data with services that require real-world ID (finance, ICOs, etc.). Please see the `manual `_ for details. +.. Autogenerated page: True +.. _passport-tree: -.. toctree:: - :titlesonly: - - telegram.credentials - telegram.datacredentials - telegram.encryptedcredentials - telegram.encryptedpassportelement - telegram.filecredentials - telegram.iddocumentdata - telegram.passportdata - telegram.passportelementerror - telegram.passportelementerrordatafield - telegram.passportelementerrorfile - telegram.passportelementerrorfiles - telegram.passportelementerrorfrontside - telegram.passportelementerrorreverseside - telegram.passportelementerrorselfie - telegram.passportelementerrortranslationfile - telegram.passportelementerrortranslationfiles - telegram.passportelementerrorunspecified - telegram.passportfile - telegram.personaldetails - telegram.residentialaddress - telegram.securedata - telegram.securevalue +Passport +-------- diff --git a/docs/source/telegram.passportdata.rst b/docs/source/telegram.passportdata.rst index 8fad1edb2f5..5f683d7b52b 100644 --- a/docs/source/telegram.passportdata.rst +++ b/docs/source/telegram.passportdata.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportData ============ -.. autoclass:: telegram.PassportData +.. currentmodule:: telegram + +.. autoclass:: PassportData :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerror.rst b/docs/source/telegram.passportelementerror.rst index f2a5ccbd678..10660e35f13 100644 --- a/docs/source/telegram.passportelementerror.rst +++ b/docs/source/telegram.passportelementerror.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementError ==================== -.. autoclass:: telegram.PassportElementError +.. currentmodule:: telegram + +.. autoclass:: PassportElementError :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrordatafield.rst b/docs/source/telegram.passportelementerrordatafield.rst index a697f70fe8c..1e4652105f6 100644 --- a/docs/source/telegram.passportelementerrordatafield.rst +++ b/docs/source/telegram.passportelementerrordatafield.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorDataField ============================= -.. autoclass:: telegram.PassportElementErrorDataField +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorDataField :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorfile.rst b/docs/source/telegram.passportelementerrorfile.rst index 28117533268..a981279eee4 100644 --- a/docs/source/telegram.passportelementerrorfile.rst +++ b/docs/source/telegram.passportelementerrorfile.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorFile ======================== -.. autoclass:: telegram.PassportElementErrorFile +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorFile :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorfiles.rst b/docs/source/telegram.passportelementerrorfiles.rst index b537e33473a..8f713c5e434 100644 --- a/docs/source/telegram.passportelementerrorfiles.rst +++ b/docs/source/telegram.passportelementerrorfiles.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorFiles ========================= -.. autoclass:: telegram.PassportElementErrorFiles +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorFiles :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorfrontside.rst b/docs/source/telegram.passportelementerrorfrontside.rst index 0b3126f852d..2cd00936e95 100644 --- a/docs/source/telegram.passportelementerrorfrontside.rst +++ b/docs/source/telegram.passportelementerrorfrontside.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorFrontSide ============================= -.. autoclass:: telegram.PassportElementErrorFrontSide +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorFrontSide :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorreverseside.rst b/docs/source/telegram.passportelementerrorreverseside.rst index 401bced1887..3165a4f6f82 100644 --- a/docs/source/telegram.passportelementerrorreverseside.rst +++ b/docs/source/telegram.passportelementerrorreverseside.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorReverseSide =============================== -.. autoclass:: telegram.PassportElementErrorReverseSide +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorReverseSide :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorselfie.rst b/docs/source/telegram.passportelementerrorselfie.rst index ce5b2f2bdcf..d48aac3dcef 100644 --- a/docs/source/telegram.passportelementerrorselfie.rst +++ b/docs/source/telegram.passportelementerrorselfie.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorSelfie ========================== -.. autoclass:: telegram.PassportElementErrorSelfie +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorSelfie :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrortranslationfile.rst b/docs/source/telegram.passportelementerrortranslationfile.rst index 4aa055b752f..3a225cb4acc 100644 --- a/docs/source/telegram.passportelementerrortranslationfile.rst +++ b/docs/source/telegram.passportelementerrortranslationfile.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorTranslationFile =================================== -.. autoclass:: telegram.PassportElementErrorTranslationFile +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorTranslationFile :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrortranslationfiles.rst b/docs/source/telegram.passportelementerrortranslationfiles.rst index 36c4e223eda..db8f6c91a3e 100644 --- a/docs/source/telegram.passportelementerrortranslationfiles.rst +++ b/docs/source/telegram.passportelementerrortranslationfiles.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorTranslationFiles ==================================== -.. autoclass:: telegram.PassportElementErrorTranslationFiles +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorTranslationFiles :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorunspecified.rst b/docs/source/telegram.passportelementerrorunspecified.rst index be3987822c9..b0ef6977543 100644 --- a/docs/source/telegram.passportelementerrorunspecified.rst +++ b/docs/source/telegram.passportelementerrorunspecified.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportElementErrorUnspecified =============================== -.. autoclass:: telegram.PassportElementErrorUnspecified +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorUnspecified :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportfile.rst b/docs/source/telegram.passportfile.rst index 643ba3df897..f285ddf1ec0 100644 --- a/docs/source/telegram.passportfile.rst +++ b/docs/source/telegram.passportfile.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PassportFile ============ -.. autoclass:: telegram.PassportFile +.. currentmodule:: telegram + +.. autoclass:: PassportFile :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.payments-tree.rst b/docs/source/telegram.payments-tree.rst index 94e4fec3c99..5d07f94f47b 100644 --- a/docs/source/telegram.payments-tree.rst +++ b/docs/source/telegram.payments-tree.rst @@ -1,36 +1,6 @@ +.. Autogenerated page: True + .. _payments-tree: Payments -------- - -Your bot can accept payments from Telegram users. Please see the `introduction to payments `_ for more details on the process and how to set up payments for your bot. - - -.. toctree:: - :titlesonly: - - telegram.affiliateinfo - telegram.invoice - telegram.labeledprice - telegram.orderinfo - telegram.precheckoutquery - telegram.refundedpayment - telegram.revenuewithdrawalstate - telegram.revenuewithdrawalstatefailed - telegram.revenuewithdrawalstatepending - telegram.revenuewithdrawalstatesucceeded - telegram.shippingaddress - telegram.shippingoption - telegram.shippingquery - telegram.staramount - telegram.startransaction - telegram.startransactions - telegram.successfulpayment - telegram.transactionpartner - telegram.transactionpartneraffiliateprogram - telegram.transactionpartnerchat - telegram.transactionpartnerfragment - telegram.transactionpartnerother - telegram.transactionpartnertelegramads - telegram.transactionpartnertelegramapi - telegram.transactionpartneruser diff --git a/docs/source/telegram.personaldetails.rst b/docs/source/telegram.personaldetails.rst index dfe4408c150..37a434ab410 100644 --- a/docs/source/telegram.personaldetails.rst +++ b/docs/source/telegram.personaldetails.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PersonalDetails =============== -.. autoclass:: telegram.PersonalDetails +.. currentmodule:: telegram + +.. autoclass:: PersonalDetails :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.photosize.rst b/docs/source/telegram.photosize.rst index 53632ac9bd4..327e23603b1 100644 --- a/docs/source/telegram.photosize.rst +++ b/docs/source/telegram.photosize.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + PhotoSize ========= -.. Also lists methods of _BaseMedium, but not the ones of TelegramObject -.. autoclass:: telegram.PhotoSize +.. currentmodule:: telegram + +.. autoclass:: PhotoSize :members: - :show-inheritance: - :inherited-members: TelegramObject, object + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.poll.rst b/docs/source/telegram.poll.rst index 705215d9d12..b287aad38d7 100644 --- a/docs/source/telegram.poll.rst +++ b/docs/source/telegram.poll.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Poll ==== -.. autoclass:: telegram.Poll +.. currentmodule:: telegram + +.. autoclass:: Poll :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.pollanswer.rst b/docs/source/telegram.pollanswer.rst index 211d8abf752..2ddb525299f 100644 --- a/docs/source/telegram.pollanswer.rst +++ b/docs/source/telegram.pollanswer.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PollAnswer ========== -.. autoclass:: telegram.PollAnswer +.. currentmodule:: telegram + +.. autoclass:: PollAnswer :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.pollmedia.rst b/docs/source/telegram.pollmedia.rst index 8e7b38871b4..86e6ac9722f 100644 --- a/docs/source/telegram.pollmedia.rst +++ b/docs/source/telegram.pollmedia.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PollMedia ========= -.. autoclass:: telegram.PollMedia +.. currentmodule:: telegram + +.. autoclass:: PollMedia :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.polloption.rst b/docs/source/telegram.polloption.rst index 264f00f5217..1de17bf1fa2 100644 --- a/docs/source/telegram.polloption.rst +++ b/docs/source/telegram.polloption.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PollOption ========== -.. autoclass:: telegram.PollOption +.. currentmodule:: telegram + +.. autoclass:: PollOption :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.polloptionadded.rst b/docs/source/telegram.polloptionadded.rst index fa4638c38f0..03619e59701 100644 --- a/docs/source/telegram.polloptionadded.rst +++ b/docs/source/telegram.polloptionadded.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PollOptionAdded =============== -.. autoclass:: telegram.PollOptionAdded +.. currentmodule:: telegram + +.. autoclass:: PollOptionAdded :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.polloptiondeleted.rst b/docs/source/telegram.polloptiondeleted.rst index 74f317f5604..0f56efaf2b6 100644 --- a/docs/source/telegram.polloptiondeleted.rst +++ b/docs/source/telegram.polloptiondeleted.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PollOptionDeleted ================= -.. autoclass:: telegram.PollOptionDeleted +.. currentmodule:: telegram + +.. autoclass:: PollOptionDeleted :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.precheckoutquery.rst b/docs/source/telegram.precheckoutquery.rst index 4d2ed627ac9..53c2a1ebc5e 100644 --- a/docs/source/telegram.precheckoutquery.rst +++ b/docs/source/telegram.precheckoutquery.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PreCheckoutQuery ================ -.. autoclass:: telegram.PreCheckoutQuery +.. currentmodule:: telegram + +.. autoclass:: PreCheckoutQuery :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.preparedinlinemessage.rst b/docs/source/telegram.preparedinlinemessage.rst index 2522f8c58cf..bf53a046592 100644 --- a/docs/source/telegram.preparedinlinemessage.rst +++ b/docs/source/telegram.preparedinlinemessage.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PreparedInlineMessage ===================== -.. autoclass:: telegram.PreparedInlineMessage +.. currentmodule:: telegram + +.. autoclass:: PreparedInlineMessage :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.preparedkeyboardbutton.rst b/docs/source/telegram.preparedkeyboardbutton.rst index 7a1f40481b5..8c97748f2c6 100644 --- a/docs/source/telegram.preparedkeyboardbutton.rst +++ b/docs/source/telegram.preparedkeyboardbutton.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + PreparedKeyboardButton ====================== -.. autoclass:: telegram.PreparedKeyboardButton +.. currentmodule:: telegram + +.. autoclass:: PreparedKeyboardButton :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.proximityalerttriggered.rst b/docs/source/telegram.proximityalerttriggered.rst index 7e80117c5ab..9c1145165cc 100644 --- a/docs/source/telegram.proximityalerttriggered.rst +++ b/docs/source/telegram.proximityalerttriggered.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ProximityAlertTriggered ======================= -.. autoclass:: telegram.ProximityAlertTriggered +.. currentmodule:: telegram + +.. autoclass:: ProximityAlertTriggered :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactioncount.rst b/docs/source/telegram.reactioncount.rst index f93a4b760b8..cfa98663161 100644 --- a/docs/source/telegram.reactioncount.rst +++ b/docs/source/telegram.reactioncount.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ReactionCount ============= -.. autoclass:: telegram.ReactionCount +.. currentmodule:: telegram + +.. autoclass:: ReactionCount :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontype.rst b/docs/source/telegram.reactiontype.rst index c726049312a..39162565321 100644 --- a/docs/source/telegram.reactiontype.rst +++ b/docs/source/telegram.reactiontype.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ReactionType ============ -.. autoclass:: telegram.ReactionType +.. currentmodule:: telegram + +.. autoclass:: ReactionType :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontypecustomemoji.rst b/docs/source/telegram.reactiontypecustomemoji.rst index e4faf95d9e5..98984d65174 100644 --- a/docs/source/telegram.reactiontypecustomemoji.rst +++ b/docs/source/telegram.reactiontypecustomemoji.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ReactionTypeCustomEmoji ======================= -.. autoclass:: telegram.ReactionTypeCustomEmoji +.. currentmodule:: telegram + +.. autoclass:: ReactionTypeCustomEmoji :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontypeemoji.rst b/docs/source/telegram.reactiontypeemoji.rst index cebad3665da..c3810a86477 100644 --- a/docs/source/telegram.reactiontypeemoji.rst +++ b/docs/source/telegram.reactiontypeemoji.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ReactionTypeEmoji ================= -.. autoclass:: telegram.ReactionTypeEmoji +.. currentmodule:: telegram + +.. autoclass:: ReactionTypeEmoji :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontypepaid.rst b/docs/source/telegram.reactiontypepaid.rst index f5035a1ba5b..37d514e48eb 100644 --- a/docs/source/telegram.reactiontypepaid.rst +++ b/docs/source/telegram.reactiontypepaid.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ReactionTypePaid ================ -.. autoclass:: telegram.ReactionTypePaid +.. currentmodule:: telegram + +.. autoclass:: ReactionTypePaid :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.refundedpayment.rst b/docs/source/telegram.refundedpayment.rst index f99349c859c..21d6c95cb70 100644 --- a/docs/source/telegram.refundedpayment.rst +++ b/docs/source/telegram.refundedpayment.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + RefundedPayment =============== -.. autoclass:: telegram.RefundedPayment +.. currentmodule:: telegram + +.. autoclass:: RefundedPayment :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.replykeyboardmarkup.rst b/docs/source/telegram.replykeyboardmarkup.rst index 395124b3c7b..3e90f0f9552 100644 --- a/docs/source/telegram.replykeyboardmarkup.rst +++ b/docs/source/telegram.replykeyboardmarkup.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ReplyKeyboardMarkup =================== -.. autoclass:: telegram.ReplyKeyboardMarkup +.. currentmodule:: telegram + +.. autoclass:: ReplyKeyboardMarkup :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.replykeyboardremove.rst b/docs/source/telegram.replykeyboardremove.rst index e1e4bb30db2..fa87a656ef0 100644 --- a/docs/source/telegram.replykeyboardremove.rst +++ b/docs/source/telegram.replykeyboardremove.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ReplyKeyboardRemove =================== -.. autoclass:: telegram.ReplyKeyboardRemove +.. currentmodule:: telegram + +.. autoclass:: ReplyKeyboardRemove :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.replyparameters.rst b/docs/source/telegram.replyparameters.rst index efe32e10441..86e3757e15a 100644 --- a/docs/source/telegram.replyparameters.rst +++ b/docs/source/telegram.replyparameters.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ReplyParameters =============== -.. autoclass:: telegram.ReplyParameters +.. currentmodule:: telegram + +.. autoclass:: ReplyParameters :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.baserequest.rst b/docs/source/telegram.request.baserequest.rst index f3510e5f14f..8edba8440c9 100644 --- a/docs/source/telegram.request.baserequest.rst +++ b/docs/source/telegram.request.baserequest.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + BaseRequest =========== -.. autoclass:: telegram.request.BaseRequest +.. currentmodule:: telegram.request + +.. autoclass:: BaseRequest :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.httpxrequest.rst b/docs/source/telegram.request.httpxrequest.rst index 9c1441821ae..263b9b23044 100644 --- a/docs/source/telegram.request.httpxrequest.rst +++ b/docs/source/telegram.request.httpxrequest.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + HTTPXRequest ============ -.. autoclass:: telegram.request.HTTPXRequest +.. currentmodule:: telegram.request + +.. autoclass:: HTTPXRequest :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.requestdata.rst b/docs/source/telegram.request.requestdata.rst index 189a1929170..f5723555e89 100644 --- a/docs/source/telegram.request.requestdata.rst +++ b/docs/source/telegram.request.requestdata.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + RequestData =========== -.. autoclass:: telegram.request.RequestData +.. currentmodule:: telegram.request + +.. autoclass:: RequestData :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.rst b/docs/source/telegram.request.rst index 22292c70d72..ce77fb2d8c4 100644 --- a/docs/source/telegram.request.rst +++ b/docs/source/telegram.request.rst @@ -1,11 +1,3 @@ -telegram.request Module -======================= +.. Autogenerated page: True -.. versionadded:: 20.0 - -.. toctree:: - :titlesonly: - - telegram.request.baserequest - telegram.request.requestdata - telegram.request.httpxrequest +.. include:: telegram/request/index.rst diff --git a/docs/source/telegram.residentialaddress.rst b/docs/source/telegram.residentialaddress.rst index 00fea575646..ae57f4ea6f8 100644 --- a/docs/source/telegram.residentialaddress.rst +++ b/docs/source/telegram.residentialaddress.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ResidentialAddress ================== -.. autoclass:: telegram.ResidentialAddress +.. currentmodule:: telegram + +.. autoclass:: ResidentialAddress :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.revenuewithdrawalstate.rst b/docs/source/telegram.revenuewithdrawalstate.rst index a8b0d9ef0ef..fc250e9aa60 100644 --- a/docs/source/telegram.revenuewithdrawalstate.rst +++ b/docs/source/telegram.revenuewithdrawalstate.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + RevenueWithdrawalState ====================== -.. autoclass:: telegram.RevenueWithdrawalState +.. currentmodule:: telegram + +.. autoclass:: RevenueWithdrawalState :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.revenuewithdrawalstatefailed.rst b/docs/source/telegram.revenuewithdrawalstatefailed.rst index 63379122869..ec396a19704 100644 --- a/docs/source/telegram.revenuewithdrawalstatefailed.rst +++ b/docs/source/telegram.revenuewithdrawalstatefailed.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + RevenueWithdrawalStateFailed -============================= +============================ + +.. currentmodule:: telegram -.. autoclass:: telegram.RevenueWithdrawalStateFailed +.. autoclass:: RevenueWithdrawalStateFailed :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.revenuewithdrawalstatepending.rst b/docs/source/telegram.revenuewithdrawalstatepending.rst index 3c2110271c0..c579b4fddb0 100644 --- a/docs/source/telegram.revenuewithdrawalstatepending.rst +++ b/docs/source/telegram.revenuewithdrawalstatepending.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + RevenueWithdrawalStatePending ============================= -.. autoclass:: telegram.RevenueWithdrawalStatePending +.. currentmodule:: telegram + +.. autoclass:: RevenueWithdrawalStatePending :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst index 40bd6fdb5c7..3ca58524fb6 100644 --- a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst +++ b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + RevenueWithdrawalStateSucceeded =============================== -.. autoclass:: telegram.RevenueWithdrawalStateSucceeded +.. currentmodule:: telegram + +.. autoclass:: RevenueWithdrawalStateSucceeded :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.rst b/docs/source/telegram.rst index fe3eac4a06f..d74f9e2b234 100644 --- a/docs/source/telegram.rst +++ b/docs/source/telegram.rst @@ -1,23 +1,3 @@ -telegram package -================ - -Version Constants ------------------ - -.. automodule:: telegram - :members: __version__, __version_info__, __bot_api_version__, __bot_api_version_info__ - -Classes in this package ------------------------ - -.. toctree:: - :titlesonly: - - telegram.bot - telegram.at-tree.rst - telegram.stickers-tree.rst - telegram.inline-tree.rst - telegram.payments-tree.rst - telegram.games-tree.rst - telegram.passport-tree.rst +.. Autogenerated page: True +.. include:: telegram/index.rst diff --git a/docs/source/telegram.securedata.rst b/docs/source/telegram.securedata.rst index 9396fdfec75..f9eebec3d90 100644 --- a/docs/source/telegram.securedata.rst +++ b/docs/source/telegram.securedata.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SecureData ========== -.. autoclass:: telegram.SecureData +.. currentmodule:: telegram + +.. autoclass:: SecureData :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.securevalue.rst b/docs/source/telegram.securevalue.rst index 105bd8580c0..b6d46f83f9b 100644 --- a/docs/source/telegram.securevalue.rst +++ b/docs/source/telegram.securevalue.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SecureValue =========== -.. autoclass:: telegram.SecureValue +.. currentmodule:: telegram + +.. autoclass:: SecureValue :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.sentguestmessage.rst b/docs/source/telegram.sentguestmessage.rst index b63e0735029..9117c9eb3d1 100644 --- a/docs/source/telegram.sentguestmessage.rst +++ b/docs/source/telegram.sentguestmessage.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SentGuestMessage ================ -.. autoclass:: telegram.SentGuestMessage +.. currentmodule:: telegram + +.. autoclass:: SentGuestMessage :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.sentwebappmessage.rst b/docs/source/telegram.sentwebappmessage.rst index 1fd1dd0ab72..509627b63d1 100644 --- a/docs/source/telegram.sentwebappmessage.rst +++ b/docs/source/telegram.sentwebappmessage.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SentWebAppMessage ================= -.. autoclass:: telegram.SentWebAppMessage +.. currentmodule:: telegram + +.. autoclass:: SentWebAppMessage :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shareduser.rst b/docs/source/telegram.shareduser.rst index 52dd3885bc0..77b059498a6 100644 --- a/docs/source/telegram.shareduser.rst +++ b/docs/source/telegram.shareduser.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + SharedUser ========== -.. autoclass:: telegram.SharedUser - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: SharedUser + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shippingaddress.rst b/docs/source/telegram.shippingaddress.rst index 7704e957fdc..251117fe288 100644 --- a/docs/source/telegram.shippingaddress.rst +++ b/docs/source/telegram.shippingaddress.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ShippingAddress =============== -.. autoclass:: telegram.ShippingAddress +.. currentmodule:: telegram + +.. autoclass:: ShippingAddress :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shippingoption.rst b/docs/source/telegram.shippingoption.rst index 45359c77613..25e4e9e03ce 100644 --- a/docs/source/telegram.shippingoption.rst +++ b/docs/source/telegram.shippingoption.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ShippingOption ============== -.. autoclass:: telegram.ShippingOption +.. currentmodule:: telegram + +.. autoclass:: ShippingOption :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shippingquery.rst b/docs/source/telegram.shippingquery.rst index 400809e260c..6045ccccf30 100644 --- a/docs/source/telegram.shippingquery.rst +++ b/docs/source/telegram.shippingquery.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + ShippingQuery ============= -.. autoclass:: telegram.ShippingQuery +.. currentmodule:: telegram + +.. autoclass:: ShippingQuery :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.staramount.rst b/docs/source/telegram.staramount.rst index 9d5a6e24572..fce1d1fa4e7 100644 --- a/docs/source/telegram.staramount.rst +++ b/docs/source/telegram.staramount.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StarAmount ========== -.. autoclass:: telegram.StarAmount +.. currentmodule:: telegram + +.. autoclass:: StarAmount :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.startransaction.rst b/docs/source/telegram.startransaction.rst index b8a68c8e99e..09a585a29b0 100644 --- a/docs/source/telegram.startransaction.rst +++ b/docs/source/telegram.startransaction.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StarTransaction =============== -.. autoclass:: telegram.StarTransaction +.. currentmodule:: telegram + +.. autoclass:: StarTransaction :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.startransactions.rst b/docs/source/telegram.startransactions.rst index e71439c8c87..5881560e43a 100644 --- a/docs/source/telegram.startransactions.rst +++ b/docs/source/telegram.startransactions.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + StarTransactions ================ -.. autoclass:: telegram.StarTransactions - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: StarTransactions + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.sticker.rst b/docs/source/telegram.sticker.rst index 459629b7ecc..08c847e412a 100644 --- a/docs/source/telegram.sticker.rst +++ b/docs/source/telegram.sticker.rst @@ -1,9 +1,10 @@ +.. Autogenerated page: True + Sticker ======= -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject +.. currentmodule:: telegram -.. autoclass:: telegram.Sticker +.. autoclass:: Sticker :members: - :show-inheritance: - :inherited-members: TelegramObject, object + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.stickers-tree.rst b/docs/source/telegram.stickers-tree.rst index e45dcacb56b..d4445779d79 100644 --- a/docs/source/telegram.stickers-tree.rst +++ b/docs/source/telegram.stickers-tree.rst @@ -1,14 +1,6 @@ -Stickers --------- - -The following methods and objects allow your bot to handle stickers and sticker sets. +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _stickers-tree: - telegram.gift - telegram.gifts - telegram.inputsticker - telegram.maskposition - telegram.sticker - telegram.stickerset +Stickers +-------- diff --git a/docs/source/telegram.stickerset.rst b/docs/source/telegram.stickerset.rst index 83ec00e16cb..8911ff3b7ca 100644 --- a/docs/source/telegram.stickerset.rst +++ b/docs/source/telegram.stickerset.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StickerSet ========== -.. autoclass:: telegram.StickerSet +.. currentmodule:: telegram + +.. autoclass:: StickerSet :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.story.rst b/docs/source/telegram.story.rst index 6b3b28d4a64..d7d289e3aab 100644 --- a/docs/source/telegram.story.rst +++ b/docs/source/telegram.story.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Story ===== -.. autoclass:: telegram.Story +.. currentmodule:: telegram + +.. autoclass:: Story :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyarea.rst b/docs/source/telegram.storyarea.rst index 88c028535d6..3dba7d8984e 100644 --- a/docs/source/telegram.storyarea.rst +++ b/docs/source/telegram.storyarea.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StoryArea ========= -.. autoclass:: telegram.StoryArea +.. currentmodule:: telegram + +.. autoclass:: StoryArea :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareaposition.rst b/docs/source/telegram.storyareaposition.rst index d14aa66cb2a..b0fd4bf1102 100644 --- a/docs/source/telegram.storyareaposition.rst +++ b/docs/source/telegram.storyareaposition.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StoryAreaPosition ================= -.. autoclass:: telegram.StoryAreaPosition +.. currentmodule:: telegram + +.. autoclass:: StoryAreaPosition :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatype.rst b/docs/source/telegram.storyareatype.rst index aa4ad3312aa..8e3784ae202 100644 --- a/docs/source/telegram.storyareatype.rst +++ b/docs/source/telegram.storyareatype.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StoryAreaType ============= -.. autoclass:: telegram.StoryAreaType +.. currentmodule:: telegram + +.. autoclass:: StoryAreaType :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypelink.rst b/docs/source/telegram.storyareatypelink.rst index 493eeef5da2..834430c5b7a 100644 --- a/docs/source/telegram.storyareatypelink.rst +++ b/docs/source/telegram.storyareatypelink.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StoryAreaTypeLink ================= -.. autoclass:: telegram.StoryAreaTypeLink +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeLink :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypelocation.rst b/docs/source/telegram.storyareatypelocation.rst index 8f09ee9bf40..96c5d94932e 100644 --- a/docs/source/telegram.storyareatypelocation.rst +++ b/docs/source/telegram.storyareatypelocation.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StoryAreaTypeLocation ===================== -.. autoclass:: telegram.StoryAreaTypeLocation +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeLocation :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypesuggestedreaction.rst b/docs/source/telegram.storyareatypesuggestedreaction.rst index e099e992d61..dff17554c3a 100644 --- a/docs/source/telegram.storyareatypesuggestedreaction.rst +++ b/docs/source/telegram.storyareatypesuggestedreaction.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StoryAreaTypeSuggestedReaction ============================== -.. autoclass:: telegram.StoryAreaTypeSuggestedReaction +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeSuggestedReaction :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypeuniquegift.rst b/docs/source/telegram.storyareatypeuniquegift.rst index c6e7fd9a119..a1900d1b1c3 100644 --- a/docs/source/telegram.storyareatypeuniquegift.rst +++ b/docs/source/telegram.storyareatypeuniquegift.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StoryAreaTypeUniqueGift ======================= -.. autoclass:: telegram.StoryAreaTypeUniqueGift +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeUniqueGift :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypeweather.rst b/docs/source/telegram.storyareatypeweather.rst index a704e7eecfd..a102fac5a0b 100644 --- a/docs/source/telegram.storyareatypeweather.rst +++ b/docs/source/telegram.storyareatypeweather.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + StoryAreaTypeWeather ==================== -.. autoclass:: telegram.StoryAreaTypeWeather +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeWeather :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.successfulpayment.rst b/docs/source/telegram.successfulpayment.rst index 19b1e6db53d..7e61fb1032b 100644 --- a/docs/source/telegram.successfulpayment.rst +++ b/docs/source/telegram.successfulpayment.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuccessfulPayment ================= -.. autoclass:: telegram.SuccessfulPayment +.. currentmodule:: telegram + +.. autoclass:: SuccessfulPayment :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostapprovalfailed.rst b/docs/source/telegram.suggestedpostapprovalfailed.rst index 5b730f18583..2a9970953a2 100644 --- a/docs/source/telegram.suggestedpostapprovalfailed.rst +++ b/docs/source/telegram.suggestedpostapprovalfailed.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuggestedPostApprovalFailed =========================== -.. autoclass:: telegram.SuggestedPostApprovalFailed +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostApprovalFailed :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostapproved.rst b/docs/source/telegram.suggestedpostapproved.rst index c9e74a94652..48d8886dd1c 100644 --- a/docs/source/telegram.suggestedpostapproved.rst +++ b/docs/source/telegram.suggestedpostapproved.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuggestedPostApproved ===================== -.. autoclass:: telegram.SuggestedPostApproved +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostApproved :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostdeclined.rst b/docs/source/telegram.suggestedpostdeclined.rst index bf9194d074b..69fadfa4003 100644 --- a/docs/source/telegram.suggestedpostdeclined.rst +++ b/docs/source/telegram.suggestedpostdeclined.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuggestedPostDeclined ===================== -.. autoclass:: telegram.SuggestedPostDeclined +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostDeclined :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostinfo.rst b/docs/source/telegram.suggestedpostinfo.rst index a974dda9887..170f031b424 100644 --- a/docs/source/telegram.suggestedpostinfo.rst +++ b/docs/source/telegram.suggestedpostinfo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuggestedPostInfo ================= -.. autoclass:: telegram.SuggestedPostInfo +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostInfo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostpaid.rst b/docs/source/telegram.suggestedpostpaid.rst index 6eb4a57bbda..baf7a97df9b 100644 --- a/docs/source/telegram.suggestedpostpaid.rst +++ b/docs/source/telegram.suggestedpostpaid.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuggestedPostPaid ================= -.. autoclass:: telegram.SuggestedPostPaid +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostPaid :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostparameters.rst b/docs/source/telegram.suggestedpostparameters.rst index 5111d8fdd48..4804ea77d93 100644 --- a/docs/source/telegram.suggestedpostparameters.rst +++ b/docs/source/telegram.suggestedpostparameters.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuggestedPostParameters ======================= -.. autoclass:: telegram.SuggestedPostParameters +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostParameters :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostprice.rst b/docs/source/telegram.suggestedpostprice.rst index f5034e8f047..51f6fdb5b7e 100644 --- a/docs/source/telegram.suggestedpostprice.rst +++ b/docs/source/telegram.suggestedpostprice.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuggestedPostPrice ================== -.. autoclass:: telegram.SuggestedPostPrice +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostPrice :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostrefunded.rst b/docs/source/telegram.suggestedpostrefunded.rst index 2fb5ad1beff..bfc7efef316 100644 --- a/docs/source/telegram.suggestedpostrefunded.rst +++ b/docs/source/telegram.suggestedpostrefunded.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SuggestedPostRefunded ===================== -.. autoclass:: telegram.SuggestedPostRefunded +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostRefunded :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.switchinlinequerychosenchat.rst b/docs/source/telegram.switchinlinequerychosenchat.rst index 603a56f6ad2..e08f4fa606a 100644 --- a/docs/source/telegram.switchinlinequerychosenchat.rst +++ b/docs/source/telegram.switchinlinequerychosenchat.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + SwitchInlineQueryChosenChat =========================== -.. autoclass:: telegram.SwitchInlineQueryChosenChat +.. currentmodule:: telegram + +.. autoclass:: SwitchInlineQueryChosenChat :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.telegramobject.rst b/docs/source/telegram.telegramobject.rst index 7f1e5dbb7fa..661f1eccccc 100644 --- a/docs/source/telegram.telegramobject.rst +++ b/docs/source/telegram.telegramobject.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TelegramObject ============== -.. autoclass:: telegram.TelegramObject +.. currentmodule:: telegram + +.. autoclass:: TelegramObject :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.textquote.rst b/docs/source/telegram.textquote.rst index 4e11ff74132..87a45c121fa 100644 --- a/docs/source/telegram.textquote.rst +++ b/docs/source/telegram.textquote.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TextQuote ========= -.. autoclass:: telegram.TextQuote +.. currentmodule:: telegram + +.. autoclass:: TextQuote :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartner.rst b/docs/source/telegram.transactionpartner.rst index 1970cfb3f94..3b8afc17519 100644 --- a/docs/source/telegram.transactionpartner.rst +++ b/docs/source/telegram.transactionpartner.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TransactionPartner ================== -.. autoclass:: telegram.TransactionPartner +.. currentmodule:: telegram + +.. autoclass:: TransactionPartner :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartneraffiliateprogram.rst b/docs/source/telegram.transactionpartneraffiliateprogram.rst index dfcab6ec22b..5d920dda37b 100644 --- a/docs/source/telegram.transactionpartneraffiliateprogram.rst +++ b/docs/source/telegram.transactionpartneraffiliateprogram.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TransactionPartnerAffiliateProgram -=================================== +================================== + +.. currentmodule:: telegram -.. autoclass:: telegram.TransactionPartnerAffiliateProgram +.. autoclass:: TransactionPartnerAffiliateProgram :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnerchat.rst b/docs/source/telegram.transactionpartnerchat.rst index 3f278f05d80..7e58a8a3fc9 100644 --- a/docs/source/telegram.transactionpartnerchat.rst +++ b/docs/source/telegram.transactionpartnerchat.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TransactionPartnerChat ====================== -.. autoclass:: telegram.TransactionPartnerChat +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerChat :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnerfragment.rst b/docs/source/telegram.transactionpartnerfragment.rst index dbdad66f2df..63ff1c60d3a 100644 --- a/docs/source/telegram.transactionpartnerfragment.rst +++ b/docs/source/telegram.transactionpartnerfragment.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TransactionPartnerFragment ========================== -.. autoclass:: telegram.TransactionPartnerFragment +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerFragment :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnerother.rst b/docs/source/telegram.transactionpartnerother.rst index cbc4c41be52..69e84249f58 100644 --- a/docs/source/telegram.transactionpartnerother.rst +++ b/docs/source/telegram.transactionpartnerother.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TransactionPartnerOther ======================= -.. autoclass:: telegram.TransactionPartnerOther +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerOther :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnertelegramads.rst b/docs/source/telegram.transactionpartnertelegramads.rst index 8304bc84a06..3fb520cea42 100644 --- a/docs/source/telegram.transactionpartnertelegramads.rst +++ b/docs/source/telegram.transactionpartnertelegramads.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TransactionPartnerTelegramAds ============================= -.. autoclass:: telegram.TransactionPartnerTelegramAds +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerTelegramAds :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnertelegramapi.rst b/docs/source/telegram.transactionpartnertelegramapi.rst index 619b4a0c89f..68c69d2b0fc 100644 --- a/docs/source/telegram.transactionpartnertelegramapi.rst +++ b/docs/source/telegram.transactionpartnertelegramapi.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TransactionPartnerTelegramApi ============================= -.. autoclass:: telegram.TransactionPartnerTelegramApi +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerTelegramApi :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartneruser.rst b/docs/source/telegram.transactionpartneruser.rst index 7709bd668c4..32485d388d5 100644 --- a/docs/source/telegram.transactionpartneruser.rst +++ b/docs/source/telegram.transactionpartneruser.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + TransactionPartnerUser ====================== -.. autoclass:: telegram.TransactionPartnerUser +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerUser :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegift.rst b/docs/source/telegram.uniquegift.rst index 0d9d1a12d32..a8fc12734bd 100644 --- a/docs/source/telegram.uniquegift.rst +++ b/docs/source/telegram.uniquegift.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + UniqueGift ========== -.. autoclass:: telegram.UniqueGift - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: UniqueGift + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftbackdrop.rst b/docs/source/telegram.uniquegiftbackdrop.rst index 52264731b22..c5d5e9f8ee5 100644 --- a/docs/source/telegram.uniquegiftbackdrop.rst +++ b/docs/source/telegram.uniquegiftbackdrop.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + UniqueGiftBackdrop ================== -.. autoclass:: telegram.UniqueGiftBackdrop - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: UniqueGiftBackdrop + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftbackdropcolors.rst b/docs/source/telegram.uniquegiftbackdropcolors.rst index 40fbf609a37..8e35991e8cf 100644 --- a/docs/source/telegram.uniquegiftbackdropcolors.rst +++ b/docs/source/telegram.uniquegiftbackdropcolors.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + UniqueGiftBackdropColors ======================== -.. autoclass:: telegram.UniqueGiftBackdropColors - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: UniqueGiftBackdropColors + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftcolors.rst b/docs/source/telegram.uniquegiftcolors.rst index 3e554abd8de..3503f0b25ab 100644 --- a/docs/source/telegram.uniquegiftcolors.rst +++ b/docs/source/telegram.uniquegiftcolors.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + UniqueGiftColors ================ -.. autoclass:: telegram.UniqueGiftColors - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: UniqueGiftColors + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftinfo.rst b/docs/source/telegram.uniquegiftinfo.rst index 5d8ef6402cf..2af390ac9ec 100644 --- a/docs/source/telegram.uniquegiftinfo.rst +++ b/docs/source/telegram.uniquegiftinfo.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + UniqueGiftInfo ============== -.. autoclass:: telegram.UniqueGiftInfo - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: UniqueGiftInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftmodel.rst b/docs/source/telegram.uniquegiftmodel.rst index a0a95a04307..eda48a8a19a 100644 --- a/docs/source/telegram.uniquegiftmodel.rst +++ b/docs/source/telegram.uniquegiftmodel.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + UniqueGiftModel =============== -.. autoclass:: telegram.UniqueGiftModel - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: UniqueGiftModel + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftsymbol.rst b/docs/source/telegram.uniquegiftsymbol.rst index 8246da5cf17..4a9fbb25cd9 100644 --- a/docs/source/telegram.uniquegiftsymbol.rst +++ b/docs/source/telegram.uniquegiftsymbol.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + UniqueGiftSymbol ================ -.. autoclass:: telegram.UniqueGiftSymbol - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: UniqueGiftSymbol + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.update.rst b/docs/source/telegram.update.rst index 0c3c3f0f244..b84c853fc57 100644 --- a/docs/source/telegram.update.rst +++ b/docs/source/telegram.update.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Update ====== -.. autoclass:: telegram.Update +.. currentmodule:: telegram + +.. autoclass:: Update :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.user.rst b/docs/source/telegram.user.rst index 1e138240a79..e7e74dcccdb 100644 --- a/docs/source/telegram.user.rst +++ b/docs/source/telegram.user.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + User ==== -.. autoclass:: telegram.User +.. currentmodule:: telegram + +.. autoclass:: User :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userchatboosts.rst b/docs/source/telegram.userchatboosts.rst index 78b958f0d31..9dcdcbb3745 100644 --- a/docs/source/telegram.userchatboosts.rst +++ b/docs/source/telegram.userchatboosts.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + UserChatBoosts ============== -.. versionadded:: 20.8 +.. currentmodule:: telegram -.. autoclass:: telegram.UserChatBoosts +.. autoclass:: UserChatBoosts :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userprofileaudios.rst b/docs/source/telegram.userprofileaudios.rst index 19582f504b1..aedb1eed9ee 100644 --- a/docs/source/telegram.userprofileaudios.rst +++ b/docs/source/telegram.userprofileaudios.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + UserProfileAudios ================= -.. autoclass:: telegram.UserProfileAudios +.. currentmodule:: telegram + +.. autoclass:: UserProfileAudios :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userprofilephotos.rst b/docs/source/telegram.userprofilephotos.rst index d9edd69a019..aba8abf82f6 100644 --- a/docs/source/telegram.userprofilephotos.rst +++ b/docs/source/telegram.userprofilephotos.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + UserProfilePhotos ================= -.. autoclass:: telegram.UserProfilePhotos +.. currentmodule:: telegram + +.. autoclass:: UserProfilePhotos :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userrating.rst b/docs/source/telegram.userrating.rst index f4a8db4a068..ab9ea6b0de2 100644 --- a/docs/source/telegram.userrating.rst +++ b/docs/source/telegram.userrating.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + UserRating ========== -.. autoclass:: telegram.UserRating +.. currentmodule:: telegram + +.. autoclass:: UserRating :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.usersshared.rst b/docs/source/telegram.usersshared.rst index 5af3457f59e..2facc573a32 100644 --- a/docs/source/telegram.usersshared.rst +++ b/docs/source/telegram.usersshared.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + UsersShared =========== -.. autoclass:: telegram.UsersShared +.. currentmodule:: telegram + +.. autoclass:: UsersShared :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.venue.rst b/docs/source/telegram.venue.rst index f54e598a0dd..0bb332c435c 100644 --- a/docs/source/telegram.venue.rst +++ b/docs/source/telegram.venue.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + Venue ===== -.. autoclass:: telegram.Venue +.. currentmodule:: telegram + +.. autoclass:: Venue :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.video.rst b/docs/source/telegram.video.rst index bcda1026431..81cdf3b5a56 100644 --- a/docs/source/telegram.video.rst +++ b/docs/source/telegram.video.rst @@ -1,9 +1,10 @@ +.. Autogenerated page: True + Video ===== -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject +.. currentmodule:: telegram -.. autoclass:: telegram.Video +.. autoclass:: Video :members: - :show-inheritance: - :inherited-members: TelegramObject, object \ No newline at end of file + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videochatended.rst b/docs/source/telegram.videochatended.rst index 02ba5742b3f..471b0baa4e1 100644 --- a/docs/source/telegram.videochatended.rst +++ b/docs/source/telegram.videochatended.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + VideoChatEnded ============== -.. autoclass:: telegram.VideoChatEnded - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: VideoChatEnded + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videochatparticipantsinvited.rst b/docs/source/telegram.videochatparticipantsinvited.rst index 84f30143053..306903989e3 100644 --- a/docs/source/telegram.videochatparticipantsinvited.rst +++ b/docs/source/telegram.videochatparticipantsinvited.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + VideoChatParticipantsInvited ============================ -.. autoclass:: telegram.VideoChatParticipantsInvited - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: VideoChatParticipantsInvited + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videochatscheduled.rst b/docs/source/telegram.videochatscheduled.rst index 0e69b89949c..090577889f7 100644 --- a/docs/source/telegram.videochatscheduled.rst +++ b/docs/source/telegram.videochatscheduled.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + VideoChatScheduled ================== -.. autoclass:: telegram.VideoChatScheduled +.. currentmodule:: telegram + +.. autoclass:: VideoChatScheduled :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videochatstarted.rst b/docs/source/telegram.videochatstarted.rst index 005dde65ee9..30f7f48aaf2 100644 --- a/docs/source/telegram.videochatstarted.rst +++ b/docs/source/telegram.videochatstarted.rst @@ -1,7 +1,10 @@ +.. Autogenerated page: True + VideoChatStarted ================ -.. autoclass:: telegram.VideoChatStarted - :members: - :show-inheritance: +.. currentmodule:: telegram +.. autoclass:: VideoChatStarted + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videonote.rst b/docs/source/telegram.videonote.rst index e7b504fb515..e40e63349bb 100644 --- a/docs/source/telegram.videonote.rst +++ b/docs/source/telegram.videonote.rst @@ -1,9 +1,10 @@ +.. Autogenerated page: True + VideoNote ========= -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject +.. currentmodule:: telegram -.. autoclass:: telegram.VideoNote +.. autoclass:: VideoNote :members: - :show-inheritance: - :inherited-members: TelegramObject, object \ No newline at end of file + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videoquality.rst b/docs/source/telegram.videoquality.rst index da1583d7bfe..7e4fd5ae19b 100644 --- a/docs/source/telegram.videoquality.rst +++ b/docs/source/telegram.videoquality.rst @@ -1,8 +1,10 @@ +.. Autogenerated page: True + VideoQuality ============ -.. Also lists methods of _BaseMedium, but not the ones of TelegramObject -.. autoclass:: telegram.VideoQuality +.. currentmodule:: telegram + +.. autoclass:: VideoQuality :members: - :show-inheritance: - :inherited-members: TelegramObject, object + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.voice.rst b/docs/source/telegram.voice.rst index b1530967bd2..5819685136e 100644 --- a/docs/source/telegram.voice.rst +++ b/docs/source/telegram.voice.rst @@ -1,9 +1,10 @@ +.. Autogenerated page: True + Voice ===== -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject +.. currentmodule:: telegram -.. autoclass:: telegram.Voice +.. autoclass:: Voice :members: - :show-inheritance: - :inherited-members: TelegramObject, object + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.warnings.rst b/docs/source/telegram.warnings.rst index 7af6887b1db..18d5f3a5143 100644 --- a/docs/source/telegram.warnings.rst +++ b/docs/source/telegram.warnings.rst @@ -1,6 +1,3 @@ -telegram.warnings Module -======================== +.. Autogenerated page: True -.. automodule:: telegram.warnings - :members: - :show-inheritance: +.. include:: telegram/warnings.rst diff --git a/docs/source/telegram.webappdata.rst b/docs/source/telegram.webappdata.rst index 003414419c8..621762cf318 100644 --- a/docs/source/telegram.webappdata.rst +++ b/docs/source/telegram.webappdata.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + WebAppData ========== -.. autoclass:: telegram.WebAppData +.. currentmodule:: telegram + +.. autoclass:: WebAppData :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.webappinfo.rst b/docs/source/telegram.webappinfo.rst index 85423c2c5f0..fb7a71d3484 100644 --- a/docs/source/telegram.webappinfo.rst +++ b/docs/source/telegram.webappinfo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + WebAppInfo ========== -.. autoclass:: telegram.WebAppInfo +.. currentmodule:: telegram + +.. autoclass:: WebAppInfo :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.webhookinfo.rst b/docs/source/telegram.webhookinfo.rst index b58027ec015..2c872daf89d 100644 --- a/docs/source/telegram.webhookinfo.rst +++ b/docs/source/telegram.webhookinfo.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + WebhookInfo =========== -.. autoclass:: telegram.WebhookInfo +.. currentmodule:: telegram + +.. autoclass:: WebhookInfo :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.writeaccessallowed.rst b/docs/source/telegram.writeaccessallowed.rst index 81ffffa1625..76a601c7da7 100644 --- a/docs/source/telegram.writeaccessallowed.rst +++ b/docs/source/telegram.writeaccessallowed.rst @@ -1,6 +1,10 @@ +.. Autogenerated page: True + WriteAccessAllowed ================== -.. autoclass:: telegram.WriteAccessAllowed +.. currentmodule:: telegram + +.. autoclass:: WriteAccessAllowed :members: - :show-inheritance: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram/chat.rst b/docs/source/telegram/chat.rst new file mode 100644 index 00000000000..73d06a7a915 --- /dev/null +++ b/docs/source/telegram/chat.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: False + +Chat +==== + +.. Also lists methods of _ChatBase, but not the ones of TelegramObject +.. autoclass:: telegram.Chat + :members: + :show-inheritance: + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram/chatfullinfo.rst b/docs/source/telegram/chatfullinfo.rst new file mode 100644 index 00000000000..e048a4b59be --- /dev/null +++ b/docs/source/telegram/chatfullinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: False + +ChatFullInfo +============ + +.. Also lists methods of _ChatBase, but not the ones of TelegramObject +.. autoclass:: telegram.ChatFullInfo + :members: + :show-inheritance: + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram/constants.rst b/docs/source/telegram/constants.rst new file mode 100644 index 00000000000..30ab75ce0b1 --- /dev/null +++ b/docs/source/telegram/constants.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: False + +telegram.constants Module +========================= + +.. automodule:: telegram.constants + :members: + :show-inheritance: + :no-undoc-members: + :exclude-members: __format__, __new__, __repr__, __str__ diff --git a/docs/source/telegram/error.rst b/docs/source/telegram/error.rst new file mode 100644 index 00000000000..845d1785743 --- /dev/null +++ b/docs/source/telegram/error.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +telegram.error Module +===================== + +.. automodule:: telegram.error + :members: + :show-inheritance: diff --git a/docs/source/telegram/ext/applicationbuilder.rst b/docs/source/telegram/ext/applicationbuilder.rst new file mode 100644 index 00000000000..bc6c2abf3d5 --- /dev/null +++ b/docs/source/telegram/ext/applicationbuilder.rst @@ -0,0 +1,7 @@ +.. Autogenerated page: False + +ApplicationBuilder +================== + +.. autoclass:: telegram.ext.ApplicationBuilder + :members: diff --git a/docs/source/telegram/ext/callbackcontext.rst b/docs/source/telegram/ext/callbackcontext.rst new file mode 100644 index 00000000000..6eb15e17d3a --- /dev/null +++ b/docs/source/telegram/ext/callbackcontext.rst @@ -0,0 +1,7 @@ +.. Autogenerated page: False + +CallbackContext +=============== + +.. autoclass:: telegram.ext.CallbackContext + :members: diff --git a/docs/source/telegram/ext/extbot.rst b/docs/source/telegram/ext/extbot.rst new file mode 100644 index 00000000000..51c17893d97 --- /dev/null +++ b/docs/source/telegram/ext/extbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +ExtBot +====== + +.. autoclass:: telegram.ext.ExtBot + :show-inheritance: + :members: insert_callback_data, defaults, rate_limiter, initialize, shutdown, callback_data_cache diff --git a/docs/source/telegram/ext/filters.rst b/docs/source/telegram/ext/filters.rst new file mode 100644 index 00000000000..09658ee2056 --- /dev/null +++ b/docs/source/telegram/ext/filters.rst @@ -0,0 +1,13 @@ +.. Autogenerated page: False + +filters Module +============== + +.. :bysource: since e.g filters.CHAT is much above filters.Chat() in the docs when it shouldn't. + The classes in `filters.py` are sorted alphabetically such that :bysource: still is readable + +.. automodule:: telegram.ext.filters + :inherited-members: BaseFilter, MessageFilter, UpdateFilter, object + :members: + :show-inheritance: + :member-order: bysource diff --git a/docs/source/telegram/ext/index.rst b/docs/source/telegram/ext/index.rst new file mode 100644 index 00000000000..30ed00a9f07 --- /dev/null +++ b/docs/source/telegram/ext/index.rst @@ -0,0 +1,6 @@ +.. Autogenerated page: False + +telegram.ext package +==================== + +.. automodule:: telegram.ext diff --git a/docs/source/telegram/ext/persistenceinput.rst b/docs/source/telegram/ext/persistenceinput.rst new file mode 100644 index 00000000000..e83b5beb83b --- /dev/null +++ b/docs/source/telegram/ext/persistenceinput.rst @@ -0,0 +1,7 @@ +.. Autogenerated page: False + +PersistenceInput +================ + +.. autoclass:: telegram.ext.PersistenceInput + :show-inheritance: diff --git a/docs/source/telegram/helpers.rst b/docs/source/telegram/helpers.rst new file mode 100644 index 00000000000..9cf64e728b5 --- /dev/null +++ b/docs/source/telegram/helpers.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +telegram.helpers Module +======================= + +.. automodule:: telegram.helpers + :members: + :show-inheritance: diff --git a/docs/source/telegram/index.rst b/docs/source/telegram/index.rst new file mode 100644 index 00000000000..aabff46fcf3 --- /dev/null +++ b/docs/source/telegram/index.rst @@ -0,0 +1,13 @@ +.. Autogenerated page: False + +telegram package +================ + +Version Constants +----------------- + +.. automodule:: telegram + :members: __version__, __version_info__, __bot_api_version__, __bot_api_version_info__ + +Classes in this package +----------------------- diff --git a/docs/source/telegram/inputpollmedia.rst b/docs/source/telegram/inputpollmedia.rst new file mode 100644 index 00000000000..020a8e5191b --- /dev/null +++ b/docs/source/telegram/inputpollmedia.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +InputPollMedia +============== + +.. versionadded:: NEXT.VERSION + +.. autoclass:: telegram.InputPollMedia diff --git a/docs/source/telegram/inputpolloptionmedia.rst b/docs/source/telegram/inputpolloptionmedia.rst new file mode 100644 index 00000000000..0fbb79b4fd6 --- /dev/null +++ b/docs/source/telegram/inputpolloptionmedia.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +InputPollOptionMedia +==================== + +.. versionadded:: NEXT.VERSION + +.. autoclass:: telegram.InputPollOptionMedia diff --git a/docs/source/telegram/request/index.rst b/docs/source/telegram/request/index.rst new file mode 100644 index 00000000000..c4f1bff63c6 --- /dev/null +++ b/docs/source/telegram/request/index.rst @@ -0,0 +1,6 @@ +.. Autogenerated page: False + +telegram.request Module +======================= + +.. versionadded:: 20.0 diff --git a/docs/source/telegram/warnings.rst b/docs/source/telegram/warnings.rst new file mode 100644 index 00000000000..5646c36a4a6 --- /dev/null +++ b/docs/source/telegram/warnings.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +telegram.warnings Module +======================== + +.. automodule:: telegram.warnings + :members: + :show-inheritance: diff --git a/docs/source/telegram_auxil.rst b/docs/source/telegram_auxil.rst index 19b26d609fa..adfc6a576cd 100644 --- a/docs/source/telegram_auxil.rst +++ b/docs/source/telegram_auxil.rst @@ -1,11 +1,3 @@ -Auxiliary modules -================= +.. Autogenerated page: True -.. toctree:: - :titlesonly: - - telegram.constants - telegram.error - telegram.helpers - telegram.request - telegram.warnings +.. include:: telegram_auxil/index.rst diff --git a/docs/source/telegram_auxil/index.rst b/docs/source/telegram_auxil/index.rst new file mode 100644 index 00000000000..6c35f89f457 --- /dev/null +++ b/docs/source/telegram_auxil/index.rst @@ -0,0 +1,4 @@ +.. Autogenerated page: False + +Auxiliary modules +================= diff --git a/docs/substitutions/global.rst b/docs/substitutions/global.rst index f1bad363716..a079bc812a6 100644 --- a/docs/substitutions/global.rst +++ b/docs/substitutions/global.rst @@ -56,7 +56,7 @@ .. |datetime_localization| replace:: The default timezone of the bot is used for localization, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. -.. |post_methods_note| replace:: If you implement custom logic that implies that you will **not** be using :class:`~telegram.ext.Application`'s methods :meth:`~telegram.ext.Application.run_polling` or :meth:`~telegram.ext.Application.run_webhook` to run your application (like it's done in `Custom Webhook Bot Example `__), the callback you set in this method **will not be called automatically**. So instead of setting a callback with this method, you have to explicitly ``await`` the function that you want to run at this stage of your application's life (in the `example mentioned above `__, that would be in ``async with application`` context manager). +.. |post_methods_note| replace:: If you implement custom logic that implies that you will **not** be using :class:`~telegram.ext.Application`'s methods :meth:`~telegram.ext.Application.run_polling` or :meth:`~telegram.ext.Application.run_webhook` to run your application (like it's done in `Custom Webhook Bot Example `__), the callback you set in this method **will not be called automatically**. So instead of setting a callback with this method, you have to explicitly ``await`` the function that you want to run at this stage of your application's life (in the `example mentioned above `__, that would be in ``async with application`` context manager). .. |removed_thumb_note| replace:: Removed the deprecated argument and attribute ``thumb``. diff --git a/examples/README.md b/examples/README.md index 78c907eaf50..76b0d9b25be 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,5 @@ # Examples -A description of the examples in this directory can be found in the [documentation](https://docs.python-telegram-bot.org/examples.html). +A description of the examples in this directory can be found in the [documentation](https://docs.python-telegram-bot.org/examples/index.html). -All examples are licensed under the [CC0 License](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/LICENSE.txt) and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights. \ No newline at end of file +All examples are licensed under the [CC0 License](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/LICENSE.txt) and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights. diff --git a/src/telegram/_bot.py b/src/telegram/_bot.py index fe325d4b87a..4402508d08f 100644 --- a/src/telegram/_bot.py +++ b/src/telegram/_bot.py @@ -210,7 +210,7 @@ class Bot(TelegramObject, contextlib.AbstractAsyncContextManager["Bot"]): :exc:`TypeError`. Examples: - :any:`Raw API Bot ` + :doc:`Raw API Bot ` .. seealso:: :wiki:`Your First Bot `, :wiki:`Builder Pattern ` @@ -4835,7 +4835,7 @@ async def set_webhook( :meth:`telegram.ext.Updater.start_webhook` Examples: - :any:`Custom Webhook Bot ` + :doc:`Custom Webhook Bot ` Args: url (:obj:`str`): HTTPS url to send updates to. Use an empty string to remove webhook diff --git a/src/telegram/_chatboost.py b/src/telegram/_chatboost.py index 2386f2e6a5c..928179a23fd 100644 --- a/src/telegram/_chatboost.py +++ b/src/telegram/_chatboost.py @@ -351,6 +351,8 @@ class ChatBoostRemoved(TelegramObject): considered equal, if their :attr:`chat`, :attr:`boost_id`, :attr:`remove_date`, and :attr:`source` are equal. + .. versionadded:: 20.8 + Args: chat (:class:`telegram.Chat`): Chat which was boosted. boost_id (:obj:`str`): Unique identifier of the boost. diff --git a/src/telegram/_chatmember.py b/src/telegram/_chatmember.py index 52e12d8fc3e..596b054f4ff 100644 --- a/src/telegram/_chatmember.py +++ b/src/telegram/_chatmember.py @@ -48,7 +48,7 @@ class ChatMember(TelegramObject): considered equal, if their :attr:`user` and :attr:`status` are equal. Examples: - :any:`Chat Member Bot ` + :doc:`Chat Member Bot ` .. versionchanged:: 20.0 diff --git a/src/telegram/_chatmemberupdated.py b/src/telegram/_chatmemberupdated.py index 2434376d459..9272ee7dc1d 100644 --- a/src/telegram/_chatmemberupdated.py +++ b/src/telegram/_chatmemberupdated.py @@ -47,7 +47,7 @@ class ChatMemberUpdated(TelegramObject): In Python :keyword:`from` is a reserved word. Use :paramref:`from_user` instead. Examples: - :any:`Chat Member Bot ` + :doc:`Chat Member Bot ` Args: chat (:class:`telegram.Chat`): Chat the user belongs to. diff --git a/src/telegram/_inline/inlinekeyboardbutton.py b/src/telegram/_inline/inlinekeyboardbutton.py index 7915ac0aa8e..87fcf4333e3 100644 --- a/src/telegram/_inline/inlinekeyboardbutton.py +++ b/src/telegram/_inline/inlinekeyboardbutton.py @@ -70,8 +70,8 @@ class InlineKeyboardButton(TelegramObject): * After Bot API 6.1, only ``HTTPS`` links will be allowed in :paramref:`login_url`. Examples: - * :any:`Inline Keyboard 1 ` - * :any:`Inline Keyboard 2 ` + * :doc:`Inline Keyboard 1 ` + * :doc:`Inline Keyboard 2 ` .. seealso:: :class:`telegram.InlineKeyboardMarkup` diff --git a/src/telegram/_inline/inlinekeyboardmarkup.py b/src/telegram/_inline/inlinekeyboardmarkup.py index 37040bc9ec5..6da1c068848 100644 --- a/src/telegram/_inline/inlinekeyboardmarkup.py +++ b/src/telegram/_inline/inlinekeyboardmarkup.py @@ -47,8 +47,8 @@ class InlineKeyboardMarkup(TelegramObject): Another kind of keyboard would be the :class:`telegram.ReplyKeyboardMarkup`. Examples: - * :any:`Inline Keyboard 1 ` - * :any:`Inline Keyboard 2 ` + * :doc:`Inline Keyboard 1 ` + * :doc:`Inline Keyboard 2 ` Args: inline_keyboard (Sequence[Sequence[:class:`telegram.InlineKeyboardButton`]]): Sequence of diff --git a/src/telegram/_inline/inlinequeryresult.py b/src/telegram/_inline/inlinequeryresult.py index 7e708ebbfe2..2a53a2d0255 100644 --- a/src/telegram/_inline/inlinequeryresult.py +++ b/src/telegram/_inline/inlinequeryresult.py @@ -38,7 +38,7 @@ class InlineQueryResult(TelegramObject): be assumed to be *public*. Examples: - :any:`Inline Bot ` + :doc:`Inline Bot ` Args: type (:obj:`str`): Type of the result. diff --git a/src/telegram/_inline/inlinequeryresultarticle.py b/src/telegram/_inline/inlinequeryresultarticle.py index cca861b76f7..cae59dd4417 100644 --- a/src/telegram/_inline/inlinequeryresultarticle.py +++ b/src/telegram/_inline/inlinequeryresultarticle.py @@ -33,7 +33,7 @@ class InlineQueryResultArticle(InlineQueryResult): """This object represents a Telegram InlineQueryResultArticle. Examples: - :any:`Inline Bot ` + :doc:`Inline Bot ` .. versionchanged:: 20.5 Removed the deprecated arguments and attributes ``thumb_*``. diff --git a/src/telegram/_inline/inputtextmessagecontent.py b/src/telegram/_inline/inputtextmessagecontent.py index 6edde810673..661c2adefe9 100644 --- a/src/telegram/_inline/inputtextmessagecontent.py +++ b/src/telegram/_inline/inputtextmessagecontent.py @@ -39,7 +39,7 @@ class InputTextMessageContent(InputMessageContent): considered equal, if their :attr:`message_text` is equal. Examples: - :any:`Inline Bot ` + :doc:`Inline Bot ` Args: message_text (:obj:`str`): Text of the message to be sent, diff --git a/src/telegram/_keyboardbuttonpolltype.py b/src/telegram/_keyboardbuttonpolltype.py index 86baadb8fa4..a4b50fe669e 100644 --- a/src/telegram/_keyboardbuttonpolltype.py +++ b/src/telegram/_keyboardbuttonpolltype.py @@ -32,7 +32,7 @@ class KeyboardButtonPollType(TelegramObject): considered equal, if their :attr:`type` is equal. Examples: - :any:`Poll Bot ` + :doc:`Poll Bot ` Args: type (:obj:`str`, optional): If :tg-const:`telegram.Poll.QUIZ` is passed, the user will be diff --git a/src/telegram/_message.py b/src/telegram/_message.py index 0eab6e314f9..5d2506012cd 100644 --- a/src/telegram/_message.py +++ b/src/telegram/_message.py @@ -927,7 +927,7 @@ class Message(MaybeInaccessibleMessage): passport_data (:class:`telegram.PassportData`): Optional. Telegram Passport data. Examples: - :any:`Passport Bot ` + :doc:`Passport Bot ` poll (:class:`telegram.Poll`): Optional. Message is a native poll, information about the poll. dice (:class:`telegram.Dice`): Optional. Message is a dice with random value. diff --git a/src/telegram/_payment/labeledprice.py b/src/telegram/_payment/labeledprice.py index a9526d4f069..ead5acf39e7 100644 --- a/src/telegram/_payment/labeledprice.py +++ b/src/telegram/_payment/labeledprice.py @@ -29,7 +29,7 @@ class LabeledPrice(TelegramObject): considered equal, if their :attr:`label` and :attr:`amount` are equal. Examples: - :any:`Payment Bot ` + :doc:`Payment Bot ` Args: label (:obj:`str`): Portion label. diff --git a/src/telegram/_payment/shippingoption.py b/src/telegram/_payment/shippingoption.py index 0b0a987a013..2b1e0c0e78a 100644 --- a/src/telegram/_payment/shippingoption.py +++ b/src/telegram/_payment/shippingoption.py @@ -36,7 +36,7 @@ class ShippingOption(TelegramObject): considered equal, if their :attr:`id` is equal. Examples: - :any:`Payment Bot ` + :doc:`Payment Bot ` Args: id (:obj:`str`): Shipping option identifier. diff --git a/src/telegram/_poll.py b/src/telegram/_poll.py index 17541bff388..0d026c632dc 100644 --- a/src/telegram/_poll.py +++ b/src/telegram/_poll.py @@ -755,7 +755,7 @@ class Poll(TelegramObject): considered equal, if their :attr:`id` is equal. Examples: - :any:`Poll Bot ` + :doc:`Poll Bot ` Args: id (:obj:`str`): Unique poll identifier. diff --git a/src/telegram/_replykeyboardmarkup.py b/src/telegram/_replykeyboardmarkup.py index 99ac0de3b00..44ec79f4c88 100644 --- a/src/telegram/_replykeyboardmarkup.py +++ b/src/telegram/_replykeyboardmarkup.py @@ -48,8 +48,8 @@ class ReplyKeyboardMarkup(TelegramObject): * Example usage: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. - * :any:`Conversation Bot ` - * :any:`Conversation Bot 2 ` + * :doc:`Conversation Bot ` + * :doc:`Conversation Bot 2 ` Args: keyboard (Sequence[Sequence[:obj:`str` | :class:`telegram.KeyboardButton`]]): Array of diff --git a/src/telegram/_replykeyboardremove.py b/src/telegram/_replykeyboardremove.py index 05a5839595a..e39b66d0921 100644 --- a/src/telegram/_replykeyboardremove.py +++ b/src/telegram/_replykeyboardremove.py @@ -38,8 +38,8 @@ class ReplyKeyboardRemove(TelegramObject): * Example usage: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. - * :any:`Conversation Bot ` - * :any:`Conversation Bot 2 ` + * :doc:`Conversation Bot ` + * :doc:`Conversation Bot 2 ` Args: selective (:obj:`bool`, optional): Use this parameter if you want to remove the keyboard diff --git a/src/telegram/_update.py b/src/telegram/_update.py index 1af292cce8d..b52341cc67c 100644 --- a/src/telegram/_update.py +++ b/src/telegram/_update.py @@ -198,7 +198,7 @@ class Update(TelegramObject): callback_query (:class:`telegram.CallbackQuery`): Optional. New incoming callback query. Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` shipping_query (:class:`telegram.ShippingQuery`): Optional. New incoming shipping query. Only for invoices with flexible price. pre_checkout_query (:class:`telegram.PreCheckoutQuery`): Optional. New incoming diff --git a/src/telegram/_webappdata.py b/src/telegram/_webappdata.py index 04583cf99f5..0bd5e7de098 100644 --- a/src/telegram/_webappdata.py +++ b/src/telegram/_webappdata.py @@ -29,7 +29,7 @@ class WebAppData(TelegramObject): considered equal, if their :attr:`data` and :attr:`button_text` are equal. Examples: - :any:`Webapp Bot ` + :doc:`Webapp Bot ` .. versionadded:: 20.0 diff --git a/src/telegram/_webappinfo.py b/src/telegram/_webappinfo.py index 2d29cef7df5..526df7ab391 100644 --- a/src/telegram/_webappinfo.py +++ b/src/telegram/_webappinfo.py @@ -30,7 +30,7 @@ class WebAppInfo(TelegramObject): considered equal, if their :attr:`url` are equal. Examples: - :any:`Webapp Bot ` + :doc:`Webapp Bot ` .. versionadded:: 20.0 diff --git a/src/telegram/error.py b/src/telegram/error.py index 014bf8631b3..95030d656b6 100644 --- a/src/telegram/error.py +++ b/src/telegram/error.py @@ -101,7 +101,7 @@ class Forbidden(TelegramError): """Raised when the bot has not enough rights to perform the requested action. Examples: - :any:`Raw API Bot ` + :doc:`Raw API Bot ` .. versionchanged:: 20.0 This class was previously named ``Unauthorized``. @@ -146,7 +146,7 @@ class NetworkError(TelegramError): `attribute `_. Examples: - :any:`Raw API Bot ` + :doc:`Raw API Bot ` .. seealso:: :wiki:`Handling network errors ` diff --git a/src/telegram/ext/_application.py b/src/telegram/ext/_application.py index d4a216e6b27..257e9c9c48f 100644 --- a/src/telegram/ext/_application.py +++ b/src/telegram/ext/_application.py @@ -158,7 +158,7 @@ class Application( of that or :obj:`None`. Examples: - :any:`Echo Bot ` + :doc:`Echo Bot ` .. seealso:: :wiki:`Your First Bot `, :wiki:`Architecture Overview ` @@ -1804,7 +1804,7 @@ def add_error_handler( Attempts to add the same callback multiple times will be ignored. Examples: - :any:`Errorhandler Bot ` + :doc:`Errorhandler Bot ` Hint: This method currently has no influence on calls to :meth:`process_error` that are diff --git a/src/telegram/ext/_applicationbuilder.py b/src/telegram/ext/_applicationbuilder.py index 97e55089502..9d9a8ef5077 100644 --- a/src/telegram/ext/_applicationbuilder.py +++ b/src/telegram/ext/_applicationbuilder.py @@ -900,7 +900,7 @@ def private_key( for :attr:`telegram.ext.Application.bot`. Examples: - :any:`Passport Bot ` + :doc:`Passport Bot ` .. seealso:: :wiki:`Telegram Passports ` @@ -962,7 +962,7 @@ def arbitrary_callback_data( pip install "python-telegram-bot[callback-data]" Examples: - :any:`Arbitrary callback_data Bot ` + :doc:`Arbitrary callback_data Bot ` .. seealso:: :wiki:`Arbitrary callback_data ` @@ -1093,7 +1093,7 @@ def job_queue( instantiated if the requirements of :class:`telegram.ext.JobQueue` are installed. Examples: - :any:`Timer Bot ` + :doc:`Timer Bot ` .. seealso:: :wiki:`Job Queue ` @@ -1133,7 +1133,7 @@ def persistence( to the persistence in order to avoid race conditions. Examples: - :any:`Persistent Conversation Bot ` + :doc:`Persistent Conversation Bot ` .. seealso:: :wiki:`Making Your Bot Persistent ` @@ -1158,7 +1158,7 @@ def context_types( :attr:`telegram.ext.Application.context_types`. Examples: - :any:`Context Types Bot ` + :doc:`Context Types Bot ` Args: context_types (:class:`telegram.ext.ContextTypes`): The context types. diff --git a/src/telegram/ext/_callbackcontext.py b/src/telegram/ext/_callbackcontext.py index 2689729c15c..beaa8b8917d 100644 --- a/src/telegram/ext/_callbackcontext.py +++ b/src/telegram/ext/_callbackcontext.py @@ -73,8 +73,8 @@ class CallbackContext(Generic[BT, UD, CD, BD]): 4. The type of :attr:`bot_data` (if :attr:`bot_data` is not :obj:`None`). Examples: - * :any:`Context Types Bot ` - * :any:`Custom Webhook Bot ` + * :doc:`Context Types Bot ` + * :doc:`Custom Webhook Bot ` .. seealso:: :attr:`telegram.ext.ContextTypes.DEFAULT_TYPE`, :wiki:`Job Queue ` diff --git a/src/telegram/ext/_callbackdatacache.py b/src/telegram/ext/_callbackdatacache.py index 4fd73b4ad44..7c252a5cf32 100644 --- a/src/telegram/ext/_callbackdatacache.py +++ b/src/telegram/ext/_callbackdatacache.py @@ -49,7 +49,7 @@ class InvalidCallbackData(TelegramError): Raised when the received callback data has been tampered with or deleted from cache. Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` .. seealso:: :wiki:`Arbitrary callback_data ` @@ -127,7 +127,7 @@ class CallbackDataCache: pip install "python-telegram-bot[callback-data]" Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` .. seealso:: :wiki:`Architecture Overview `, :wiki:`Arbitrary callback_data ` diff --git a/src/telegram/ext/_contexttypes.py b/src/telegram/ext/_contexttypes.py index bd975b6bdda..68e8ac7d130 100644 --- a/src/telegram/ext/_contexttypes.py +++ b/src/telegram/ext/_contexttypes.py @@ -33,7 +33,7 @@ class ContextTypes(Generic[CCT, UD, CD, BD]): interface. Examples: - :any:`ContextTypes Bot ` + :doc:`ContextTypes Bot ` .. seealso:: :wiki:`Architecture Overview `, :wiki:`Storing Bot, User and Chat Related Data ` diff --git a/src/telegram/ext/_extbot.py b/src/telegram/ext/_extbot.py index 6e54f3a7574..972480b7f07 100644 --- a/src/telegram/ext/_extbot.py +++ b/src/telegram/ext/_extbot.py @@ -166,7 +166,7 @@ class ExtBot(Bot, Generic[RLARGS]): additional argument, as this method will never be rate limited. Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` .. seealso:: :wiki:`Arbitrary callback_data ` @@ -303,7 +303,7 @@ def callback_data_cache(self) -> CallbackDataCache | None: objects passed as callback data for :class:`telegram.InlineKeyboardButton`. Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` .. versionchanged:: 20.0 * This property is now read-only. diff --git a/src/telegram/ext/_handlers/chatmemberhandler.py b/src/telegram/ext/_handlers/chatmemberhandler.py index cfdeae714ea..b4e74bd45da 100644 --- a/src/telegram/ext/_handlers/chatmemberhandler.py +++ b/src/telegram/ext/_handlers/chatmemberhandler.py @@ -38,7 +38,7 @@ class ChatMemberHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Chat Member Bot ` + :doc:`Chat Member Bot ` .. versionadded:: 13.4 diff --git a/src/telegram/ext/_handlers/commandhandler.py b/src/telegram/ext/_handlers/commandhandler.py index 8056a5acb77..459e4df3462 100644 --- a/src/telegram/ext/_handlers/commandhandler.py +++ b/src/telegram/ext/_handlers/commandhandler.py @@ -65,8 +65,8 @@ class CommandHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - * :any:`Timer Bot ` - * :any:`Error Handler Bot ` + * :doc:`Timer Bot ` + * :doc:`Error Handler Bot ` .. versionchanged:: 20.0 diff --git a/src/telegram/ext/_handlers/conversationhandler.py b/src/telegram/ext/_handlers/conversationhandler.py index 044e957aa41..9474dcab549 100644 --- a/src/telegram/ext/_handlers/conversationhandler.py +++ b/src/telegram/ext/_handlers/conversationhandler.py @@ -171,13 +171,13 @@ class ConversationHandler(BaseHandler[Update, CCT, object]): states to continue the parent conversation after the child conversation has ended or even map a state to :attr:`END` to end the *parent* conversation from within the child conversation. For an example on nested :class:`ConversationHandler` s, see - :any:`examples.nestedconversationbot`. + :doc:`/examples/nestedconversationbot`. Examples: - * :any:`Conversation Bot ` - * :any:`Conversation Bot 2 ` - * :any:`Nested Conversation Bot ` - * :any:`Persistent Conversation Bot ` + * :doc:`Conversation Bot ` + * :doc:`Conversation Bot 2 ` + * :doc:`Nested Conversation Bot ` + * :doc:`Persistent Conversation Bot ` Args: entry_points (list[:class:`telegram.ext.BaseHandler`]): A list of :obj:`BaseHandler` diff --git a/src/telegram/ext/_handlers/inlinequeryhandler.py b/src/telegram/ext/_handlers/inlinequeryhandler.py index de04b25b431..d5b37a0a247 100644 --- a/src/telegram/ext/_handlers/inlinequeryhandler.py +++ b/src/telegram/ext/_handlers/inlinequeryhandler.py @@ -49,7 +49,7 @@ class InlineQueryHandler(BaseHandler[Update, CCT, RT]): updates won't be handled, if :attr:`chat_types` is passed. Examples: - :any:`Inline Bot ` + :doc:`Inline Bot ` Args: diff --git a/src/telegram/ext/_handlers/pollanswerhandler.py b/src/telegram/ext/_handlers/pollanswerhandler.py index 5564b588d40..408ac70de9a 100644 --- a/src/telegram/ext/_handlers/pollanswerhandler.py +++ b/src/telegram/ext/_handlers/pollanswerhandler.py @@ -32,7 +32,7 @@ class PollAnswerHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Poll Bot ` + :doc:`Poll Bot ` Args: callback (:term:`coroutine function`): The callback function for this handler. Will be diff --git a/src/telegram/ext/_handlers/pollhandler.py b/src/telegram/ext/_handlers/pollhandler.py index a029bb559d1..d890a674a47 100644 --- a/src/telegram/ext/_handlers/pollhandler.py +++ b/src/telegram/ext/_handlers/pollhandler.py @@ -32,7 +32,7 @@ class PollHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Poll Bot ` + :doc:`Poll Bot ` Args: callback (:term:`coroutine function`): The callback function for this handler. Will be diff --git a/src/telegram/ext/_handlers/precheckoutqueryhandler.py b/src/telegram/ext/_handlers/precheckoutqueryhandler.py index 5fb1dab2680..8619b53eb9d 100644 --- a/src/telegram/ext/_handlers/precheckoutqueryhandler.py +++ b/src/telegram/ext/_handlers/precheckoutqueryhandler.py @@ -39,7 +39,7 @@ class PreCheckoutQueryHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Payment Bot ` + :doc:`Payment Bot ` Args: callback (:term:`coroutine function`): The callback function for this handler. Will be diff --git a/src/telegram/ext/_handlers/shippingqueryhandler.py b/src/telegram/ext/_handlers/shippingqueryhandler.py index c46fad19210..92a8f482d8a 100644 --- a/src/telegram/ext/_handlers/shippingqueryhandler.py +++ b/src/telegram/ext/_handlers/shippingqueryhandler.py @@ -31,7 +31,7 @@ class ShippingQueryHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Payment Bot ` + :doc:`Payment Bot ` Args: callback (:term:`coroutine function`): The callback function for this handler. Will be diff --git a/src/telegram/ext/_jobqueue.py b/src/telegram/ext/_jobqueue.py index 7ad54530913..1455c27a544 100644 --- a/src/telegram/ext/_jobqueue.py +++ b/src/telegram/ext/_jobqueue.py @@ -81,7 +81,7 @@ class JobQueue(Generic[CCT]): pip install "python-telegram-bot[job-queue]" Examples: - :any:`Timer Bot ` + :doc:`Timer Bot ` .. seealso:: :wiki:`Architecture Overview `, :wiki:`Job Queue ` diff --git a/src/telegram/ext/_picklepersistence.py b/src/telegram/ext/_picklepersistence.py index f97a0ab0fbc..c6b9ce2c33c 100644 --- a/src/telegram/ext/_picklepersistence.py +++ b/src/telegram/ext/_picklepersistence.py @@ -134,7 +134,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): :attr:`~BasePersistence.bot` will be inserted back when loading the data. Examples: - :any:`Persistent Conversation Bot ` + :doc:`Persistent Conversation Bot ` .. seealso:: :wiki:`Making Your Bot Persistent ` diff --git a/src/telegram/helpers.py b/src/telegram/helpers.py index 1c30a303afc..e5cdf33562f 100644 --- a/src/telegram/helpers.py +++ b/src/telegram/helpers.py @@ -163,7 +163,7 @@ def create_deep_linked_url( Examples: * ``create_deep_linked_url(bot.get_me().username, "some-params")`` - * :any:`Deep Linking ` + * :doc:`Deep Linking ` Args: bot_username (:obj:`str`): The username to link to.