diff --git a/docs/source/aiogram.bot.rst b/docs/source/aiogram.bot.rst deleted file mode 100644 index 6747f9da..00000000 --- a/docs/source/aiogram.bot.rst +++ /dev/null @@ -1,16 +0,0 @@ -Bot object -========== - -For detailed information about parameters read the official `Telegram Bot API reference `_ - -BaseBot -------- -.. automodule:: aiogram.bot.base - :members: - :show-inheritance: - -Bot ---- -.. automodule:: aiogram.bot.bot - :members: - :show-inheritance: diff --git a/docs/source/aiogram.rst b/docs/source/aiogram.rst index 0e35222a..f596abb8 100644 --- a/docs/source/aiogram.rst +++ b/docs/source/aiogram.rst @@ -7,6 +7,6 @@ Submodules .. toctree:: - aiogram.bot - aiogram.types - aiogram.dispatcher + bot/bot + bot/types + dispatcher/ diff --git a/docs/source/bot/additional.rst b/docs/source/bot/additional.rst new file mode 100644 index 00000000..68ea8bc4 --- /dev/null +++ b/docs/source/bot/additional.rst @@ -0,0 +1,4 @@ +Bot object +========== + +.. autoclass:: aiogram.bot.bot.Bot \ No newline at end of file diff --git a/docs/source/bot/base.rst b/docs/source/bot/base.rst new file mode 100644 index 00000000..fee95f75 --- /dev/null +++ b/docs/source/bot/base.rst @@ -0,0 +1,4 @@ +BaseBot +======= + +.. autoclass:: aiogram.bot.base.BaseBot diff --git a/docs/source/bot/bot.rst b/docs/source/bot/bot.rst new file mode 100644 index 00000000..ce543fc4 --- /dev/null +++ b/docs/source/bot/bot.rst @@ -0,0 +1,9 @@ +Bot object +========== + +For detailed information about parameters read the official `Telegram Bot API reference `_ + +.. toctree:: + + base + additional diff --git a/docs/source/aiogram.types.rst b/docs/source/bot/types.rst similarity index 100% rename from docs/source/aiogram.types.rst rename to docs/source/bot/types.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index 15847741..9902e455 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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", +] diff --git a/docs/source/aiogram.dispatcher.rst b/docs/source/dispatcher/dispatcher.rst similarity index 100% rename from docs/source/aiogram.dispatcher.rst rename to docs/source/dispatcher/dispatcher.rst