Documentation Improvements (#3386)

Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com> Co-authored-by: Viicos <65306057+Viicos@users.noreply.github.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
python-telegram-bot · Dec 15, 2022 · 9467847 · 9467847
1 parent b11a0c7
commit 9467847
Show file tree

Hide file tree

Showing 21 changed files with 152 additions and 105 deletions.
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
@@ -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
diff --git a/docs/source/telegram.at-tree.rst b/docs/source/telegram.at-tree.rst
@@ -2,6 +2,7 @@ Available Types
 ---------------
 
 .. toctree::
+    :titlesonly:
 
     telegram.animation
     telegram.audio

diff --git a/docs/source/telegram.ext.acd-tree.rst b/docs/source/telegram.ext.acd-tree.rst
@@ -2,6 +2,7 @@ Arbitrary Callback Data
 -----------------------
 
 .. toctree::
+    :titlesonly:
 
     telegram.ext.callbackdatacache
     telegram.ext.invalidcallbackdata
diff --git a/docs/source/telegram.ext.handlers-tree.rst b/docs/source/telegram.ext.handlers-tree.rst
@@ -2,6 +2,7 @@ Handlers
 --------
 
 .. toctree::
+    :titlesonly:
 
     telegram.ext.basehandler
     telegram.ext.callbackqueryhandler

diff --git a/docs/source/telegram.ext.persistence-tree.rst b/docs/source/telegram.ext.persistence-tree.rst
@@ -2,6 +2,7 @@ Persistence
 -----------
 
 .. toctree::
+    :titlesonly:
 
     telegram.ext.basepersistence
     telegram.ext.dictpersistence

diff --git a/docs/source/telegram.ext.rate-limiting-tree.rst b/docs/source/telegram.ext.rate-limiting-tree.rst
@@ -2,6 +2,7 @@ Rate Limiting
 -------------
 
 .. toctree::
+    :titlesonly:
 
     telegram.ext.baseratelimiter
     telegram.ext.aioratelimiter
diff --git a/docs/source/telegram.games-tree.rst b/docs/source/telegram.games-tree.rst
@@ -2,6 +2,7 @@ Games
 -----
 
 .. toctree::
+    :titlesonly:
 
     telegram.callbackgame
     telegram.game

diff --git a/docs/source/telegram.inline-tree.rst b/docs/source/telegram.inline-tree.rst
@@ -2,6 +2,7 @@ Inline Mode
 -----------
 
 .. toctree::
+    :titlesonly:
 
     telegram.choseninlineresult
     telegram.inlinequery

diff --git a/docs/source/telegram.passport-tree.rst b/docs/source/telegram.passport-tree.rst
@@ -2,6 +2,7 @@ Passport
 --------
 
 .. toctree::
+    :titlesonly:
 
     telegram.credentials
     telegram.datacredentials

diff --git a/docs/source/telegram.payments-tree.rst b/docs/source/telegram.payments-tree.rst
@@ -2,6 +2,7 @@ Payments
 --------
 
 .. toctree::
+    :titlesonly:
 
     telegram.invoice
     telegram.labeledprice

diff --git a/docs/source/telegram.request.rst b/docs/source/telegram.request.rst
@@ -4,6 +4,8 @@ telegram.request Module
 .. versionadded:: 20.0
 
 .. toctree::
+    :titlesonly:
+
     telegram.request.baserequest
     telegram.request.requestdata
     telegram.request.httpxrequest
diff --git a/docs/source/telegram.stickers-tree.rst b/docs/source/telegram.stickers-tree.rst
@@ -2,6 +2,7 @@ Stickers
 --------
 
 .. toctree::
+    :titlesonly:
 
     telegram.maskposition
     telegram.sticker

diff --git a/docs/source/telegram_auxil.rst b/docs/source/telegram_auxil.rst
@@ -2,6 +2,7 @@ Auxiliary modules
 =================
 
 .. toctree::
+    :titlesonly:
 
     telegram.constants
     telegram.error