Skip to content

Documentation Improvements #3386

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

Merged
merged 9 commits into from
Dec 15, 2022
Merged

Documentation Improvements #3386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
940a492
titles-only toctrees
Bibo-Joshi Nov 24, 2022
cf9b228
Conversationhandler docfix (#3395)
lemontree210 Nov 27, 2022
c53c721
fix(`Bot`): `:attr:`->`:meth:` in `seealso` where applicable
lemontree210 Nov 28, 2022
eb07a2b
Add more crossrefs to docstrings (#3398)
lemontree210 Nov 30, 2022
421518b
Clarify docs of the `filter` argument in `MessageHandler` (#3403)
Viicos Dec 1, 2022
9fd18c7
Add a note in the line of #3401
Bibo-Joshi Dec 3, 2022
b2c3606
update furo
harshil21 Dec 7, 2022
614bff7
Add notes about entries from {chat, user}_data not being automaticall…
Bibo-Joshi Dec 15, 2022
533293d
Merge branch 'master' into doc-fixes
Bibo-Joshi Dec 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/requirements-docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
sphinx==5.3.0
sphinx-pypi-upload
furo==2022.9.29
furo==2022.12.7
git+https://github.com/harshil21/furo-sphinx-search@be5cfa221a01f6e259bb2bb1f76d6ede7ffc1f11#egg=furo-sphinx-search
sphinx-paramlinks==0.5.4
sphinxcontrib-mermaid==0.7.1
1 change: 1 addition & 0 deletions docs/source/telegram.at-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Available Types
---------------

.. toctree::
:titlesonly:

telegram.animation
telegram.audio
Expand Down
1 change: 1 addition & 0 deletions docs/source/telegram.ext.acd-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Arbitrary Callback Data
-----------------------

.. toctree::
:titlesonly:

telegram.ext.callbackdatacache
telegram.ext.invalidcallbackdata
1 change: 1 addition & 0 deletions docs/source/telegram.ext.handlers-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Handlers
--------

.. toctree::
:titlesonly:

telegram.ext.basehandler
telegram.ext.callbackqueryhandler
Expand Down
1 change: 1 addition & 0 deletions docs/source/telegram.ext.persistence-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Persistence
-----------

.. toctree::
:titlesonly:

telegram.ext.basepersistence
telegram.ext.dictpersistence
Expand Down
1 change: 1 addition & 0 deletions docs/source/telegram.ext.rate-limiting-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Rate Limiting
-------------

.. toctree::
:titlesonly:

telegram.ext.baseratelimiter
telegram.ext.aioratelimiter
1 change: 1 addition & 0 deletions docs/source/telegram.games-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Games
-----

.. toctree::
:titlesonly:

telegram.callbackgame
telegram.game
Expand Down
1 change: 1 addition & 0 deletions docs/source/telegram.inline-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Inline Mode
-----------

.. toctree::
:titlesonly:

telegram.choseninlineresult
telegram.inlinequery
Expand Down
1 change: 1 addition & 0 deletions docs/source/telegram.passport-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Passport
--------

.. toctree::
:titlesonly:

telegram.credentials
telegram.datacredentials
Expand Down
1 change: 1 addition & 0 deletions docs/source/telegram.payments-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Payments
--------

.. toctree::
:titlesonly:

telegram.invoice
telegram.labeledprice
Expand Down
2 changes: 2 additions & 0 deletions docs/source/telegram.request.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ telegram.request Module
.. versionadded:: 20.0

.. toctree::
:titlesonly:

telegram.request.baserequest
telegram.request.requestdata
telegram.request.httpxrequest
1 change: 1 addition & 0 deletions docs/source/telegram.stickers-tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Stickers
--------

.. toctree::
:titlesonly:

telegram.maskposition
telegram.sticker
Expand Down
1 change: 1 addition & 0 deletions docs/source/telegram_auxil.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Auxiliary modules
=================

.. toctree::
:titlesonly:

telegram.constants
telegram.error
Expand Down
Loading