mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-08 17:13:56 +00:00
Update docs
This commit is contained in:
parent
b687a867b7
commit
55069c73db
8 changed files with 29 additions and 28 deletions
|
|
@ -1,16 +0,0 @@
|
|||
Bot object
|
||||
==========
|
||||
|
||||
For detailed information about parameters read the official `Telegram Bot API reference <https://core.telegram.org/bots/api>`_
|
||||
|
||||
BaseBot
|
||||
-------
|
||||
.. automodule:: aiogram.bot.base
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Bot
|
||||
---
|
||||
.. automodule:: aiogram.bot.bot
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
|
@ -7,6 +7,6 @@ Submodules
|
|||
|
||||
.. toctree::
|
||||
|
||||
aiogram.bot
|
||||
aiogram.types
|
||||
aiogram.dispatcher
|
||||
bot/bot
|
||||
bot/types
|
||||
dispatcher/
|
||||
|
|
|
|||
4
docs/source/bot/additional.rst
Normal file
4
docs/source/bot/additional.rst
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
Bot object
|
||||
==========
|
||||
|
||||
.. autoclass:: aiogram.bot.bot.Bot
|
||||
4
docs/source/bot/base.rst
Normal file
4
docs/source/bot/base.rst
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
BaseBot
|
||||
=======
|
||||
|
||||
.. autoclass:: aiogram.bot.base.BaseBot
|
||||
9
docs/source/bot/bot.rst
Normal file
9
docs/source/bot/bot.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
Bot object
|
||||
==========
|
||||
|
||||
For detailed information about parameters read the official `Telegram Bot API reference <https://core.telegram.org/bots/api>`_
|
||||
|
||||
.. toctree::
|
||||
|
||||
base
|
||||
additional
|
||||
|
|
@ -19,11 +19,11 @@
|
|||
#
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
|
||||
import aiogram
|
||||
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
|
|
@ -39,7 +39,6 @@ extensions = [
|
|||
'sphinx.ext.autodoc',
|
||||
]
|
||||
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['templates']
|
||||
|
||||
|
|
@ -84,7 +83,6 @@ pygments_style = 'sphinx'
|
|||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
|
|
@ -103,13 +101,11 @@ html_theme = 'alabaster'
|
|||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['static']
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'aiogramdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
|
|
@ -138,7 +134,6 @@ latex_documents = [
|
|||
'Illemius / Alex Root Junior', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
|
|
@ -148,7 +143,6 @@ man_pages = [
|
|||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
|
|
@ -160,5 +154,11 @@ texinfo_documents = [
|
|||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
|
||||
autoclass_content = "both"
|
||||
autodoc_member_order = "bysource"
|
||||
autodoc_default_flags = [
|
||||
"members",
|
||||
"no-undoc-members",
|
||||
"show-inheritance",
|
||||
"inherited-members",
|
||||
]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue