Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/818612 ) Change subject: [doc] Expand module index ...................................................................... [doc] Expand module index Add all pywikibot modules to modules index. Unfortunately this does not work for logging, site, and time module because this conflicts with Python library. Maybe pywikibot.scripts should be renamed to be unique from (bot) scripts module. Bug: T308063 Change-Id: Ice63e6754aed80dfd6d5fcb3bfe17137c0954e28 --- M docs/api_ref/pywikibot.comms.rst M docs/api_ref/pywikibot.config.rst M docs/api_ref/pywikibot.data.rst M docs/api_ref/pywikibot.families.rst M docs/api_ref/pywikibot.page.rst M docs/api_ref/pywikibot.pagegenerators.rst M docs/api_ref/pywikibot.rst M docs/api_ref/pywikibot.site.rst M docs/api_ref/pywikibot.specialbots.rst M docs/api_ref/pywikibot.tools.rst M docs/api_ref/pywikibot.userinterfaces.rst M docs/conf.py 12 files changed, 354 insertions(+), 352 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/docs/api_ref/pywikibot.comms.rst b/docs/api_ref/pywikibot.comms.rst index abe9441..0198120 100644 --- a/docs/api_ref/pywikibot.comms.rst +++ b/docs/api_ref/pywikibot.comms.rst @@ -1,19 +1,19 @@ -pywikibot.comms package -======================= +:mod:`comms` package +==================== -.. automodule:: pywikibot.comms +.. automodule:: comms Submodules ---------- -pywikibot.comms.eventstreams module ------------------------------------ +:mod:`comms.eventstreams` module +-------------------------------- -.. automodule:: pywikibot.comms.eventstreams +.. automodule:: comms.eventstreams -pywikibot.comms.http module ---------------------------- +:mod:`comms.http` module +------------------------ -.. automodule:: pywikibot.comms.http +.. automodule:: comms.http diff --git a/docs/api_ref/pywikibot.config.rst b/docs/api_ref/pywikibot.config.rst index a4fe0fb..68c6f02 100644 --- a/docs/api_ref/pywikibot.config.rst +++ b/docs/api_ref/pywikibot.config.rst @@ -1,10 +1,10 @@ -pywikibot.config module ------------------------ +:mod:`config` module +-------------------- API reference ^^^^^^^^^^^^^ -.. automodule:: pywikibot.config +.. automodule:: config Option setting ^^^^^^^^^^^^^^ diff --git a/docs/api_ref/pywikibot.data.rst b/docs/api_ref/pywikibot.data.rst index 12b7d14..16d02fa 100644 --- a/docs/api_ref/pywikibot.data.rst +++ b/docs/api_ref/pywikibot.data.rst @@ -1,34 +1,34 @@ -pywikibot.data package -====================== +:mod:`data` package +=================== -.. automodule:: pywikibot.data +.. automodule:: data Submodules ---------- -pywikibot.data.api module +:mod:`data.api` module +---------------------- + +.. automodule:: data.api + +:mod:`data.memento` module +-------------------------- + +.. automodule:: data.memento + +:mod:`data.mysql` module +------------------------ + +.. automodule:: data.mysql + +:mod:`data.sparql` module ------------------------- -.. automodule:: pywikibot.data.api +.. automodule:: data.sparql -pywikibot.data.memento module ------------------------------ - -.. automodule:: pywikibot.data.memento - -pywikibot.data.mysql module ---------------------------- - -.. automodule:: pywikibot.data.mysql - -pywikibot.data.sparql module +:mod:`data.wikistats` module ---------------------------- -.. automodule:: pywikibot.data.sparql - -pywikibot.data.wikistats module -------------------------------- - -.. automodule:: pywikibot.data.wikistats +.. automodule:: data.wikistats diff --git a/docs/api_ref/pywikibot.families.rst b/docs/api_ref/pywikibot.families.rst index bde8a39..ce5f8f0 100644 --- a/docs/api_ref/pywikibot.families.rst +++ b/docs/api_ref/pywikibot.families.rst @@ -1,143 +1,142 @@ -pywikibot.families package -========================== +:mod:`families` package +======================= -.. automodule:: pywikibot.families +.. automodule:: families Submodules ---------- -pywikibot.families.commons\_family module ------------------------------------------ - -.. automodule:: pywikibot.families.commons_family - -pywikibot.families.foundation\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.foundation_family - -pywikibot.families.i18n\_family module +:mod:`families.commons\_family` module -------------------------------------- -.. automodule:: pywikibot.families.i18n_family +.. automodule:: families.commons_family -pywikibot.families.incubator\_family module -------------------------------------------- +:mod:`families.foundation\_family` module +----------------------------------------- -.. automodule:: pywikibot.families.incubator_family +.. automodule:: families.foundation_family -pywikibot.families.lingualibre\_family module ---------------------------------------------- +:mod:`families.i18n\_family` module +----------------------------------- -.. automodule:: pywikibot.families.lingualibre_family +.. automodule:: families.i18n_family -pywikibot.families.mediawiki\_family module -------------------------------------------- +:mod:`families.incubator\_family` module +---------------------------------------- -.. automodule:: pywikibot.families.mediawiki_family +.. automodule:: families.incubator_family -pywikibot.families.meta\_family module +:mod:`families.lingualibre\_family` module +------------------------------------------ + +.. automodule:: families.lingualibre_family + +:mod:`families.mediawiki\_family` module +---------------------------------------- + +.. automodule:: families.mediawiki_family + +:mod:`families.meta\_family` module +----------------------------------- + +.. automodule:: families.meta_family + +:mod:`families.omegawiki\_family` module +---------------------------------------- + +.. automodule:: families.omegawiki_family + +:mod:`families.osm\_family` module +---------------------------------- + +.. automodule:: families.osm_family + +:mod:`families.outreach\_family` module +--------------------------------------- + +.. automodule:: families.outreach_family + +:mod:`families.species\_family` module -------------------------------------- -.. automodule:: pywikibot.families.meta_family +.. automodule:: families.species_family -pywikibot.families.omegawiki\_family module -------------------------------------------- +:mod:`families.vikidia\_family` module +-------------------------------------- -.. automodule:: pywikibot.families.omegawiki_family +.. automodule:: families.vikidia_family -pywikibot.families.osm\_family module -------------------------------------- +:mod:`families.wikibooks\_family` module +---------------------------------------- -.. automodule:: pywikibot.families.osm_family +.. automodule:: families.wikibooks_family -pywikibot.families.outreach\_family module ------------------------------------------- +:mod:`families.wikidata\_family` module +--------------------------------------- -.. automodule:: pywikibot.families.outreach_family +.. automodule:: families.wikidata_family -pywikibot.families.species\_family module +:mod:`families.wikihow\_family` module +-------------------------------------- + +.. automodule:: families.wikihow_family + +:mod:`families.wikimania\_family` module +---------------------------------------- + +.. automodule:: families.wikimania_family + +:mod:`families.wikimediachapter\_family` module +----------------------------------------------- + +.. automodule:: families.wikimediachapter_family + +:mod:`families.wikinews\_family` module +--------------------------------------- + +.. automodule:: families.wikinews_family + +:mod:`families.wikipedia\_family` module +---------------------------------------- + +.. automodule:: families.wikipedia_family + +:mod:`families.wikiquote\_family` module +---------------------------------------- + +.. automodule:: families.wikiquote_family + +:mod:`families.wikisource\_family` module ----------------------------------------- -.. automodule:: pywikibot.families.species_family +.. automodule:: families.wikisource_family -pywikibot.families.vikidia\_family module +:mod:`families.wikisopore\_family` module ----------------------------------------- -.. automodule:: pywikibot.families.vikidia_family +.. automodule:: families.wikispore_family -pywikibot.families.wikibooks\_family module -------------------------------------------- +:mod:`families.wikitech\_family` module +--------------------------------------- -.. automodule:: pywikibot.families.wikibooks_family +.. automodule:: families.wikitech_family -pywikibot.families.wikidata\_family module +:mod:`families.wikiversity\_family` module ------------------------------------------ -.. automodule:: pywikibot.families.wikidata_family +.. automodule:: families.wikiversity_family -pywikibot.families.wikihow\_family module +:mod:`families.wikivoyage\_family` module ----------------------------------------- -.. automodule:: pywikibot.families.wikihow_family +.. automodule:: families.wikivoyage_family -pywikibot.families.wikimania\_family module -------------------------------------------- - -.. automodule:: pywikibot.families.wikimania_family - -pywikibot.families.wikimediachapter\_family module --------------------------------------------------- - -.. automodule:: pywikibot.families.wikimediachapter_family - -pywikibot.families.wikinews\_family module ------------------------------------------- - -.. automodule:: pywikibot.families.wikinews_family - -pywikibot.families.wikipedia\_family module -------------------------------------------- - -.. automodule:: pywikibot.families.wikipedia_family - -pywikibot.families.wikiquote\_family module -------------------------------------------- - -.. automodule:: pywikibot.families.wikiquote_family - -pywikibot.families.wikisource\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.wikisource_family - -pywikibot.families.wikisopore\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.wikispore_family - -pywikibot.families.wikitech\_family module ------------------------------------------- - -.. automodule:: pywikibot.families.wikitech_family - -pywikibot.families.wikiversity\_family module ---------------------------------------------- - -.. automodule:: pywikibot.families.wikiversity_family - -pywikibot.families.wikivoyage\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.wikivoyage_family - -pywikibot.families.wiktionary\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.wiktionary_family - -pywikibot.families.wowwiki\_family module +:mod:`families.wiktionary\_family` module ----------------------------------------- -.. automodule:: pywikibot.families.wowwiki_family +.. automodule:: families.wiktionary_family +:mod:`families.wowwiki\_family` module +-------------------------------------- + +.. automodule:: families.wowwiki_family diff --git a/docs/api_ref/pywikibot.page.rst b/docs/api_ref/pywikibot.page.rst index 512ecd2..a990fb5 100644 --- a/docs/api_ref/pywikibot.page.rst +++ b/docs/api_ref/pywikibot.page.rst @@ -1,22 +1,22 @@ -pywikibot.page package -======================= +:mod:`page` package +=================== -.. automodule:: pywikibot.page +.. automodule:: page Submodules ---------- -pywikibot.page.\_collections module ------------------------------------ - -.. automodule:: pywikibot.page._collections - -pywikibot.page.\_decorators module ----------------------------------- - -.. automodule:: pywikibot.page._decorators - -pywikibot.page.\_revision module +:mod:`page.\_collections` module -------------------------------- -.. automodule:: pywikibot.page._revision +.. automodule:: page._collections + +:mod:`page.\_decorators` module +------------------------------- + +.. automodule:: page._decorators + +:mod:`page.\_revision` module +----------------------------- + +.. automodule:: page._revision diff --git a/docs/api_ref/pywikibot.pagegenerators.rst b/docs/api_ref/pywikibot.pagegenerators.rst index 5a48ff1..6d5dc64 100644 --- a/docs/api_ref/pywikibot.pagegenerators.rst +++ b/docs/api_ref/pywikibot.pagegenerators.rst @@ -1,20 +1,19 @@ -pagegenerators package -====================== +:mod:`pagegenerators` package +============================= -.. automodule:: pywikibot.pagegenerators +.. automodule:: pagegenerators -pagegenerators.\_factory module -------------------------------- +:mod:`pagegenerators.\_factory` module +-------------------------------------- -.. automodule:: pywikibot.pagegenerators._factory +.. automodule:: pagegenerators._factory -pagegenerators.\_filters module -------------------------------- +:mod:`pagegenerators.\_filters` module +-------------------------------------- -.. automodule:: pywikibot.pagegenerators._filters +.. automodule:: pagegenerators._filters -pagegenerators.\_generators module ----------------------------------- +:mod:`pagegenerators.\_generators` module +----------------------------------------- -.. automodule:: pywikibot.pagegenerators._generators - +.. automodule:: pagegenerators._generators diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index 3e0e3b6..a12c651 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -1,7 +1,7 @@ pywikibot package ================= -.. automodule:: pywikibot +#.. automodule:: pywikibot Pywikibot Subpackages --------------------- @@ -21,143 +21,141 @@ Submodules ---------- -pywikibot.backports module --------------------------- +:mod:`backports` module +----------------------- -.. automodule:: pywikibot.backports +.. automodule:: backports -pywikibot.bot module --------------------- +:mod:`bot` module +----------------- -.. automodule:: pywikibot.bot +.. automodule:: bot :member-order: bysource -pywikibot.bot\_choice module ----------------------------- +:mod:`bot\_choice` module +------------------------- -.. automodule:: pywikibot.bot_choice +.. automodule:: bot_choice .. include:: pywikibot.config.rst -pywikibot.cosmetic\_changes module ----------------------------------- +:mod:`cosmetic\_changes` module +------------------------------- -.. automodule:: pywikibot.cosmetic_changes +.. automodule:: cosmetic_changes -pywikibot.daemonize module --------------------------- - -.. automodule:: pywikibot.daemonize - -pywikibot.date module ---------------------- - -.. automodule:: pywikibot.date - -pywikibot.diff module ---------------------- - -.. automodule:: pywikibot.diff - -pywikibot.echo module ---------------------- - -.. automodule:: pywikibot.echo - -pywikibot.editor module +:mod:`daemonize` module ----------------------- -.. automodule:: pywikibot.editor +.. automodule:: daemonize -pywikibot.exceptions module ---------------------------- +:mod:`date` module +------------------ -.. automodule:: pywikibot.exceptions +.. automodule:: date -pywikibot.family module ------------------------ +:mod:`diff` module +------------------ -.. automodule:: pywikibot.family +.. automodule:: diff -pywikibot.fixes module ----------------------- +:mod:`echo` module +------------------ -.. automodule:: pywikibot.fixes +.. automodule:: echo -pywikibot.flow module ---------------------- +:mod:`editor` module +-------------------- -.. automodule:: pywikibot.flow +.. automodule:: editor -pywikibot.i18n module ---------------------- - -.. automodule:: pywikibot.i18n - -pywikibot.interwiki\_graph module ---------------------------------- - -.. automodule:: pywikibot.interwiki_graph - -pywikibot.logentries module ---------------------------- - -.. automodule:: pywikibot.logentries - -pywikibot.logging module +:mod:`exceptions` module ------------------------ +.. automodule:: exceptions + +:mod:`family` module +-------------------- + +.. automodule:: family + +:mod:`fixes` module +------------------- + +.. automodule:: fixes + +:mod:`flow` module +------------------ + +.. automodule:: flow + +:mod:`i18n` module +------------------ + +.. automodule:: i18n + +:mod:`interwiki\_graph` module +------------------------------ + +.. automodule:: interwiki_graph + +:mod:`logentries` module +------------------------ + +.. automodule:: logentries + +:mod:`logging` module +--------------------- + .. automodule:: pywikibot.logging :member-order: bysource -pywikibot.login module +:mod:`login` module +------------------- + +.. automodule:: login + +:mod:`plural` module +-------------------- + +.. automodule:: plural + +:mod:`proofreadpage` module +--------------------------- + +.. automodule:: proofreadpage + +:mod:`site\_detect` module +-------------------------- + +.. automodule:: site_detect + +:mod:`textlib` module +--------------------- + +.. automodule:: textlib + +:mod:`throttle` module ---------------------- -.. automodule:: pywikibot.login +.. automodule:: throttle -pywikibot.plural module ------------------------ - -.. automodule:: pywikibot.plural - -pywikibot.proofreadpage module ------------------------------- - -.. automodule:: pywikibot.proofreadpage - -pywikibot.site\_detect module ------------------------------ - -.. automodule:: pywikibot.site_detect - -pywikibot.textlib module ------------------------- - -.. automodule:: pywikibot.textlib - -pywikibot.throttle module -------------------------- - -.. automodule:: pywikibot.throttle - -pywikibot.time module ---------------------- +:mod:`time` module +------------------ .. automodule:: pywikibot.time -pywikibot.titletranslate module -------------------------------- +:mod:`titletranslate` module +---------------------------- -.. automodule:: pywikibot.titletranslate +.. automodule:: titletranslate -pywikibot.version module ------------------------- +:mod:`version` module +--------------------- -.. automodule:: pywikibot.version +.. automodule:: version -pywikibot.xmlreader module --------------------------- +:mod:`xmlreader` module +----------------------- -.. automodule:: pywikibot.xmlreader - - +.. automodule:: xmlreader diff --git a/docs/api_ref/pywikibot.site.rst b/docs/api_ref/pywikibot.site.rst index cd97c76..9c0abe3 100644 --- a/docs/api_ref/pywikibot.site.rst +++ b/docs/api_ref/pywikibot.site.rst @@ -1,42 +1,49 @@ -pywikibot.site package -======================= +:mod:`site` package +=================== .. automodule:: pywikibot.site :no-members: -BaseSite package ----------------- +:mod:`BaseSite<pywikibot.site._basesite>` package +------------------------------------------------- + .. automodule:: pywikibot.site._basesite -APISite Package ---------------- +:mod:`APISite<pywikibot.site.\_apisite>` Package +------------------------------------------------ + .. automodule:: pywikibot.site._apisite .. automodule:: pywikibot.site._extensions .. automodule:: pywikibot.site._generators -DataSite Package ----------------- +:mod:`DataSite<pywikibot.site.\_datasite>` Package +-------------------------------------------------- + .. automodule:: pywikibot.site._datasite -Obsolete Sites Package ----------------------- +:mod:`Obsolete Sites<pywikibot.site._obsoletesites>` Package +------------------------------------------------------------ + .. automodule:: pywikibot.site._obsoletesites -Siteinfo Package ----------------- +:mod:`Siteinfo<pywikibot.site._siteinfo>` Package +------------------------------------------------- + .. automodule:: pywikibot.site._siteinfo -Namespace Package ------------------ +:mod:`Namespace<pywikibot.site._namespace>` Package +--------------------------------------------------- + .. automodule:: pywikibot.site._namespace -TokenWallet Package -------------------- +:mod:`TokenWallet<pywikibot.site._tokenwallet>` Package +------------------------------------------------------- + .. automodule:: pywikibot.site._tokenwallet -Uploader Package ----------------- -.. automodule:: pywikibot.site._upload +:mod:`Uploader<pywikibot.site._upload>` Package +----------------------------------------------- +.. automodule:: pywikibot.site._upload diff --git a/docs/api_ref/pywikibot.specialbots.rst b/docs/api_ref/pywikibot.specialbots.rst index 8208d51..7a84fe0 100644 --- a/docs/api_ref/pywikibot.specialbots.rst +++ b/docs/api_ref/pywikibot.specialbots.rst @@ -1,4 +1,4 @@ -specialbots package -=================== +:mod:`specialbots` package +========================== -.. automodule:: pywikibot.specialbots +.. automodule:: specialbots diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst index be71273..caff513 100644 --- a/docs/api_ref/pywikibot.tools.rst +++ b/docs/api_ref/pywikibot.tools.rst @@ -1,39 +1,39 @@ -tools package -============= +:mod:`tools` package +==================== -.. automodule:: pywikibot.tools +.. automodule:: tools -tools.chars module ------------------- +:mod:`tools.chars` module +------------------------- -.. automodule:: pywikibot.tools.chars +.. automodule:: tools.chars -tools.collections module +:mod:`tools.collections` module +------------------------------- + +.. automodule:: tools.collections + +:mod:`tools.deprecate` module +----------------------------- + +.. automodule:: tools._deprecate + +:mod:`tools.djvu` module ------------------------ -.. automodule:: pywikibot.tools.collections +.. automodule:: tools.djvu -tools.deprecate module ----------------------- +:mod:`tools.formatter` module +----------------------------- -.. automodule:: pywikibot.tools._deprecate +.. automodule:: tools.formatter -tools.djvu module ------------------ +:mod:`tools.itertools` module +----------------------------- -.. automodule:: pywikibot.tools.djvu +.. automodule:: tools.itertools -tools.formatter module ----------------------- +:mod:`tools.\_logging` module +----------------------------- -.. automodule:: pywikibot.tools.formatter - -tools.itertools module ----------------------- - -.. automodule:: pywikibot.tools.itertools - -tools.\_logging module ----------------------- - -.. automodule:: pywikibot.tools._logging +.. automodule:: tools._logging diff --git a/docs/api_ref/pywikibot.userinterfaces.rst b/docs/api_ref/pywikibot.userinterfaces.rst index 0c05a30..0885943 100644 --- a/docs/api_ref/pywikibot.userinterfaces.rst +++ b/docs/api_ref/pywikibot.userinterfaces.rst @@ -1,51 +1,49 @@ -userinterfaces package -====================== +:mod:`userinterfaces` package +============================= -.. automodule:: pywikibot.userinterfaces +.. automodule:: userinterfaces -\_interface\_base module ------------------------- +:mod:`\_interface\_base` module +------------------------------- -.. automodule:: pywikibot.userinterfaces._interface_base +.. automodule:: userinterfaces._interface_base -terminal\_interface module --------------------------- - -.. automodule:: pywikibot.userinterfaces.terminal_interface - -terminal\_interface\_base module --------------------------------- - -.. automodule:: pywikibot.userinterfaces.terminal_interface_base - -terminal\_interface\_unix module --------------------------------- - -.. automodule:: pywikibot.userinterfaces.terminal_interface_unix - -terminal\_interface\_win32 module +:mod:`terminal\_interface` module --------------------------------- -.. automodule:: pywikibot.userinterfaces.terminal_interface_win32 +.. automodule:: userinterfaces.terminal_interface -buffer\_interface module ------------------------- +:mod:`terminal\_interface\_base` module +--------------------------------------- -.. automodule:: pywikibot.userinterfaces.buffer_interface +.. automodule:: userinterfaces.terminal_interface_base -gui module ----------- +:mod:`terminal\_interface\_unix` module +--------------------------------------- -.. automodule:: pywikibot.userinterfaces.gui +.. automodule:: userinterfaces.terminal_interface_unix -transliteration module ----------------------- +:mod:`terminal\_interface\_win32` module +---------------------------------------- -.. automodule:: pywikibot.userinterfaces.transliteration +.. automodule:: userinterfaces.terminal_interface_win32 -win32\_unicode module ---------------------- +:mod:`buffer\_interface` module +------------------------------- -.. automodule:: pywikibot.userinterfaces.win32_unicode +.. automodule:: userinterfaces.buffer_interface +:mod:`gui` module +----------------- +.. automodule:: userinterfaces.gui + +:mod:`transliteration` module +----------------------------- + +.. automodule:: userinterfaces.transliteration + +:mod:`win32\_unicode` module +---------------------------- + +.. automodule:: userinterfaces.win32_unicode diff --git a/docs/conf.py b/docs/conf.py index e1f2037..a6b12ea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,6 +34,7 @@ docs_dir = dirname(__file__) repo_dir = abspath(join(docs_dir, '..')) +sys.path.insert(0, repo_dir + '/pywikibot') sys.path.insert(0, repo_dir) os.chdir(repo_dir) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/818612 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Ice63e6754aed80dfd6d5fcb3bfe17137c0954e28 Gerrit-Change-Number: 818612 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged