jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1042937?usp=email )
Change subject: [doc] prevent multiple entries in Sphinx documentation ......................................................................
[doc] prevent multiple entries in Sphinx documentation
Some classes and functions of bot module are imported in pywikibot and can also be used as pywikibot members. Remove the documentation from pywikibot and add a reference to bot module for them.
Change-Id: Ic9ac9604023828017e15a7854ef71ebecc29091c --- M docs/api_ref/bot.rst M docs/api_ref/pywikibot.rst 2 files changed, 32 insertions(+), 0 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/docs/api_ref/bot.rst b/docs/api_ref/bot.rst index 640902f..2e17aa9 100644 --- a/docs/api_ref/bot.rst +++ b/docs/api_ref/bot.rst @@ -6,6 +6,21 @@ :synopsis: User-interface related functions for building bots :member-order: bysource
+ .. admonition:: Imports in :mod:`pywikibot` module + + The following classes and functions are inported in :mod:`pywikibot` + module and can also be used as :mod:`pywikibot` members: + + - :class:`pywikibot.Bot<bot.Bot>` + - :class:`pywikibot.CurrentPageBot<bot.CurrentPageBot>` + - :class:`pywikibot.WikidataBot<bot.WikidataBot>` + - :func:`pywikibot.calledModuleName<bot.calledModuleName>` + - :func:`pywikibot.handle_args<bot.handle_args>` + - :func:`pywikibot.input<bot.input>` + - :func:`pywikibot.input_choice<bot.input_choice>` + - :func:`pywikibot.input_yn<bot.input_yn>` + - :func:`pywikibot.show_help<bot.show_help>` + .. autoclass:: BaseBot
.. attribute:: generator diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index 3e87817..b3e6b92 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -3,3 +3,20 @@ ***********************************************
.. automodule:: pywikibot + :exclude-members: Bot, CurrentPageBot, WikidataBot, calledModuleName, + handle_args, input, input_choice, input_yn, show_help + + .. admonition:: Imports from :mod:`bot` module + + The following classes and functions are inported from :mod:`bot` module + but can also be used as :mod:`pywikibot` members: + + - :class:`pywikibot.Bot<bot.Bot>` + - :class:`pywikibot.CurrentPageBot<bot.CurrentPageBot>` + - :class:`pywikibot.WikidataBot<bot.WikidataBot>` + - :func:`pywikibot.calledModuleName<bot.calledModuleName>` + - :func:`pywikibot.handle_args<bot.handle_args>` + - :func:`pywikibot.input<bot.input>` + - :func:`pywikibot.input_choice<bot.input_choice>` + - :func:`pywikibot.input_yn<bot.input_yn>` + - :func:`pywikibot.show_help<bot.show_help>`
pywikibot-commits@lists.wikimedia.org