jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/816259 )

Change subject: [doc] Update pagegenerators doc ......................................................................

[doc] Update pagegenerators doc

Change-Id: I8e5adc57dc3d243d0c417ab723ae89468b04e2a5 --- A docs/api_ref/pywikibot.pagegenerators.rst M docs/api_ref/pywikibot.rst M pywikibot/pagegenerators/_factory.py M pywikibot/pagegenerators/_filters.py M pywikibot/pagegenerators/_generators.py 5 files changed, 24 insertions(+), 47 deletions(-)

Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified

diff --git a/docs/api_ref/pywikibot.pagegenerators.rst b/docs/api_ref/pywikibot.pagegenerators.rst new file mode 100644 index 0000000..5a48ff1 --- /dev/null +++ b/docs/api_ref/pywikibot.pagegenerators.rst @@ -0,0 +1,20 @@ +pagegenerators package +====================== + +.. automodule:: pywikibot.pagegenerators + +pagegenerators._factory module +------------------------------- + +.. automodule:: pywikibot.pagegenerators._factory + +pagegenerators._filters module +------------------------------- + +.. automodule:: pywikibot.pagegenerators._filters + +pagegenerators._generators module +---------------------------------- + +.. automodule:: pywikibot.pagegenerators._generators + diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index 76d1495..3e0e3b6 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -12,6 +12,7 @@ pywikibot.data pywikibot.families pywikibot.page + pywikibot.pagegenerators pywikibot.site pywikibot.specialbots pywikibot.tools @@ -114,11 +115,6 @@

.. automodule:: pywikibot.login

-pywikibot.pagegenerators module -------------------------------- - -.. automodule:: pywikibot.pagegenerators - pywikibot.plural module -----------------------

diff --git a/pywikibot/pagegenerators/_factory.py b/pywikibot/pagegenerators/_factory.py index 7c5e268..61ca0d3 100644 --- a/pywikibot/pagegenerators/_factory.py +++ b/pywikibot/pagegenerators/_factory.py @@ -1,17 +1,4 @@ -""" -This module offers a wide variety of page generators. - -A page generator is an object that is iterable (see :pep:`255`) and -that yields page objects on which other scripts can then work. - -Most of these functions just wrap a Site or Page method that returns a -generator. For testing purposes listpages.py can be used, to print page -titles to standard output. - -These parameters are supported to specify which pages titles to print: - -&params; -""" +"""GeneratorFactory module wich handles pagegenerators options.""" # # (C) Pywikibot team, 2008-2022 # diff --git a/pywikibot/pagegenerators/_filters.py b/pywikibot/pagegenerators/_filters.py index 9e471d1..bf12b34 100644 --- a/pywikibot/pagegenerators/_filters.py +++ b/pywikibot/pagegenerators/_filters.py @@ -1,17 +1,4 @@ -""" -This module offers a wide variety of page generators. - -A page generator is an object that is iterable (see :pep:`255`) and -that yields page objects on which other scripts can then work. - -Most of these functions just wrap a Site or Page method that returns a -generator. For testing purposes listpages.py can be used, to print page -titles to standard output. - -These parameters are supported to specify which pages titles to print: - -&params; -""" +"""Page filter generators provided by the pagegenerators module.""" # # (C) Pywikibot team, 2008-2022 # diff --git a/pywikibot/pagegenerators/_generators.py b/pywikibot/pagegenerators/_generators.py index 7505b33..f45ba45 100644 --- a/pywikibot/pagegenerators/_generators.py +++ b/pywikibot/pagegenerators/_generators.py @@ -1,17 +1,4 @@ -""" -This module offers a wide variety of page generators. - -A page generator is an object that is iterable (see :pep:`255`) and -that yields page objects on which other scripts can then work. - -Most of these functions just wrap a Site or Page method that returns a -generator. For testing purposes listpages.py can be used, to print page -titles to standard output. - -These parameters are supported to specify which pages titles to print: - -&params; -""" +"""Page filter generators provided by the pagegenerators module.""" # # (C) Pywikibot team, 2008-2022 #