Skip to content

Autogenerate .rst file generation #5323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
harshil21 wants to merge 4 commits into
base: doc-fixes
Choose a base branch
from
Open

Autogenerate .rst file generation #5323

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
65624b0
Initial .rst autogeneration code
harshil21 Jul 27, 2026
041a0bc
Remove AI slop, organize .rst files into folders
harshil21 Aug 4, 2026
08c768e
Only use examples/, remove autogen files for examples in source/
harshil21 Aug 4, 2026
84a463d
Remove invalid AI change
harshil21 Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Prev Previous commit
Next Next commit
Remove AI slop, organize .rst files into folders
  • Loading branch information
@harshil21
harshil21 committed Aug 4, 2026
commit 041a0bc101c7a179ef0b25dcbc05bc29016edef7
10 changes: 0 additions & 10 deletions .github/CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,16 +231,6 @@ or, if you don't have ``make`` available (e.g. on Windows):

Once the process terminates, you can view the built documentation by opening ``docs/build/html/index.html`` with a browser.

- Reference pages for public objects exported in the ``__all__`` of ``telegram``, ``telegram.ext`` and
``telegram.request`` are generated automatically during the Sphinx build. Do not add a
``docs/source/telegram.<class>.rst`` file for a normal class. New objects are added to their
package's default toctree automatically. To list an object in one of the specialized sections
instead, add its lower-case document name to the corresponding ``*-tree.rst`` file.
An object that cannot be rendered correctly by the shared template may keep a manual RST page.
Such a page must start with the manual-page marker defined in ``docs/auxil/api_docs.py`` and be
explicitly unignored in ``.gitignore``. Rare custom autodoc options are also configured in
``docs/auxil/api_docs.py``.

- Add ``.. versionadded:: NEXT.VERSION``, ``.. versionchanged:: NEXT.VERSION`` or ``.. deprecated:: NEXT.VERSION`` to the associated documentation of your changes, depending on what kind of change you made. This only applies if the change you made is visible to an end user. The directives should be added to class/method descriptions if their general behaviour changed and to the description of all arguments & attributes that changed.
For a new class, put ``.. versionadded:: NEXT.VERSION`` in the class docstring.

Expand Down
23 changes: 0 additions & 23 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,29 +64,6 @@ coverage.xml
# Sphinx documentation
docs/_build/

# Transient API pages generated by docs.auxil.api_docs
/docs/source/telegram.*.rst
!/docs/source/telegram.rst
!/docs/source/telegram.at-tree.rst
!/docs/source/telegram.constants.rst
!/docs/source/telegram.error.rst
!/docs/source/telegram.ext.acd-tree.rst
!/docs/source/telegram.ext.filters.rst
!/docs/source/telegram.ext.handlers-tree.rst
!/docs/source/telegram.ext.persistence-tree.rst
!/docs/source/telegram.ext.rate-limiting-tree.rst
!/docs/source/telegram.ext.rst
!/docs/source/telegram.games-tree.rst
!/docs/source/telegram.helpers.rst
!/docs/source/telegram.inline-tree.rst
!/docs/source/telegram.passport-tree.rst
!/docs/source/telegram.payments-tree.rst
!/docs/source/telegram.request.rst
!/docs/source/telegram.stickers-tree.rst
!/docs/source/telegram.warnings.rst
!/docs/source/telegram.inputpollmedia.rst
!/docs/source/telegram.inputpolloptionmedia.rst

# PyBuilder
target/
.idea/
Expand Down
Loading