jenkins-bot has submitted this change and it was merged.
Change subject: sphinx-apidoc update of pywikibot package
......................................................................
sphinx-apidoc update of pywikibot package
Adds modules backports, comms.rcstream, data.wikistats, tools,
proofreadpage, cosmetic_changes and daemonize.
Change-Id: I3ee161a0927e984dcfeb6656b1588182205d9bb9
---
M docs/api_ref/pywikibot.comms.rst
M docs/api_ref/pywikibot.compat.rst
M docs/api_ref/pywikibot.data.rst
M docs/api_ref/pywikibot.families.rst
M docs/api_ref/pywikibot.rst
A docs/api_ref/pywikibot.tools.rst
M docs/api_ref/pywikibot.userinterfaces.rst
7 files changed, 381 insertions(+), 322 deletions(-)
Approvals:
John Vandenberg: Looks good to me, but someone else must approve
XZise: Looks good to me, approved
jenkins-bot: Verified
diff --git a/docs/api_ref/pywikibot.comms.rst b/docs/api_ref/pywikibot.comms.rst
index 072809f..2c25c5d 100644
--- a/docs/api_ref/pywikibot.comms.rst
+++ b/docs/api_ref/pywikibot.comms.rst
@@ -1,27 +1,34 @@
-comms Package
-=============
-
-:mod:`comms` Package
---------------------
+pywikibot.comms package
+=======================
.. automodule:: pywikibot.comms
:members:
:undoc-members:
:show-inheritance:
-:mod:`http` Module
-------------------
+Submodules
+----------
+
+pywikibot.comms.http module
+---------------------------
.. automodule:: pywikibot.comms.http
:members:
:undoc-members:
:show-inheritance:
-:mod:`threadedhttp` Module
---------------------------
+pywikibot.comms.rcstream module
+-------------------------------
+
+.. automodule:: pywikibot.comms.rcstream
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.comms.threadedhttp module
+-----------------------------------
.. automodule:: pywikibot.comms.threadedhttp
:members:
:undoc-members:
:show-inheritance:
-
diff --git a/docs/api_ref/pywikibot.compat.rst b/docs/api_ref/pywikibot.compat.rst
index 159f682..d059d1a 100644
--- a/docs/api_ref/pywikibot.compat.rst
+++ b/docs/api_ref/pywikibot.compat.rst
@@ -1,35 +1,34 @@
-compat Package
-==============
-
-:mod:`compat` Package
----------------------
+pywikibot.compat package
+========================
.. automodule:: pywikibot.compat
:members:
:undoc-members:
:show-inheritance:
-:mod:`catlib` Module
---------------------
+Submodules
+----------
+
+pywikibot.compat.catlib module
+------------------------------
.. automodule:: pywikibot.compat.catlib
:members:
:undoc-members:
:show-inheritance:
-:mod:`query` Module
--------------------
+pywikibot.compat.query module
+-----------------------------
.. automodule:: pywikibot.compat.query
:members:
:undoc-members:
:show-inheritance:
-:mod:`userlib` Module
----------------------
+pywikibot.compat.userlib module
+-------------------------------
.. automodule:: pywikibot.compat.userlib
:members:
:undoc-members:
:show-inheritance:
-
diff --git a/docs/api_ref/pywikibot.data.rst b/docs/api_ref/pywikibot.data.rst
index f14fd1e..16f51f7 100644
--- a/docs/api_ref/pywikibot.data.rst
+++ b/docs/api_ref/pywikibot.data.rst
@@ -1,27 +1,34 @@
-data Package
-============
-
-:mod:`data` Package
--------------------
+pywikibot.data package
+======================
.. automodule:: pywikibot.data
:members:
:undoc-members:
:show-inheritance:
-:mod:`api` Module
------------------
+Submodules
+----------
+
+pywikibot.data.api module
+-------------------------
.. automodule:: pywikibot.data.api
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikidataquery` Module
----------------------------
+pywikibot.data.wikidataquery module
+-----------------------------------
.. automodule:: pywikibot.data.wikidataquery
:members:
:undoc-members:
:show-inheritance:
+pywikibot.data.wikistats module
+-------------------------------
+
+.. automodule:: pywikibot.data.wikistats
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api_ref/pywikibot.families.rst b/docs/api_ref/pywikibot.families.rst
index 6fad2d9..58cacf4 100644
--- a/docs/api_ref/pywikibot.families.rst
+++ b/docs/api_ref/pywikibot.families.rst
@@ -1,235 +1,234 @@
-families Package
-================
-
-:mod:`families` Package
------------------------
+pywikibot.families package
+==========================
.. automodule:: pywikibot.families
:members:
:undoc-members:
:show-inheritance:
-:mod:`anarchopedia_family` Module
----------------------------------
+Submodules
+----------
+
+pywikibot.families.anarchopedia_family module
+---------------------------------------------
.. automodule:: pywikibot.families.anarchopedia_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`battlestarwiki_family` Module
------------------------------------
+pywikibot.families.battlestarwiki_family module
+-----------------------------------------------
.. automodule:: pywikibot.families.battlestarwiki_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`commons_family` Module
-----------------------------
+pywikibot.families.commons_family module
+----------------------------------------
.. automodule:: pywikibot.families.commons_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`i18n_family` Module
--------------------------
+pywikibot.families.i18n_family module
+-------------------------------------
.. automodule:: pywikibot.families.i18n_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`incubator_family` Module
-------------------------------
+pywikibot.families.incubator_family module
+------------------------------------------
.. automodule:: pywikibot.families.incubator_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`lyricwiki_family` Module
-------------------------------
+pywikibot.families.lyricwiki_family module
+------------------------------------------
.. automodule:: pywikibot.families.lyricwiki_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`mediawiki_family` Module
-------------------------------
+pywikibot.families.mediawiki_family module
+------------------------------------------
.. automodule:: pywikibot.families.mediawiki_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`meta_family` Module
--------------------------
+pywikibot.families.meta_family module
+-------------------------------------
.. automodule:: pywikibot.families.meta_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`omegawiki_family` Module
-------------------------------
+pywikibot.families.omegawiki_family module
+------------------------------------------
.. automodule:: pywikibot.families.omegawiki_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`osm_family` Module
-------------------------
+pywikibot.families.osm_family module
+------------------------------------
.. automodule:: pywikibot.families.osm_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`outreach_family` Module
------------------------------
+pywikibot.families.outreach_family module
+-----------------------------------------
.. automodule:: pywikibot.families.outreach_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`species_family` Module
-----------------------------
+pywikibot.families.species_family module
+----------------------------------------
.. automodule:: pywikibot.families.species_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`strategy_family` Module
------------------------------
+pywikibot.families.strategy_family module
+-----------------------------------------
.. automodule:: pywikibot.families.strategy_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`test_family` Module
--------------------------
+pywikibot.families.test_family module
+-------------------------------------
.. automodule:: pywikibot.families.test_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`vikidia_family` Module
-----------------------------
+pywikibot.families.vikidia_family module
+----------------------------------------
.. automodule:: pywikibot.families.vikidia_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikia_family` Module
---------------------------
+pywikibot.families.wikia_family module
+--------------------------------------
.. automodule:: pywikibot.families.wikia_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikibooks_family` Module
-------------------------------
+pywikibot.families.wikibooks_family module
+------------------------------------------
.. automodule:: pywikibot.families.wikibooks_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikidata_family` Module
------------------------------
+pywikibot.families.wikidata_family module
+-----------------------------------------
.. automodule:: pywikibot.families.wikidata_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikimedia_family` Module
-------------------------------
+pywikibot.families.wikimedia_family module
+------------------------------------------
.. automodule:: pywikibot.families.wikimedia_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikinews_family` Module
------------------------------
+pywikibot.families.wikinews_family module
+-----------------------------------------
.. automodule:: pywikibot.families.wikinews_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikipedia_family` Module
-------------------------------
+pywikibot.families.wikipedia_family module
+------------------------------------------
.. automodule:: pywikibot.families.wikipedia_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikiquote_family` Module
-------------------------------
+pywikibot.families.wikiquote_family module
+------------------------------------------
.. automodule:: pywikibot.families.wikiquote_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikisource_family` Module
--------------------------------
+pywikibot.families.wikisource_family module
+-------------------------------------------
.. automodule:: pywikibot.families.wikisource_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikitech_family` Module
------------------------------
+pywikibot.families.wikitech_family module
+-----------------------------------------
.. automodule:: pywikibot.families.wikitech_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikiversity_family` Module
---------------------------------
+pywikibot.families.wikiversity_family module
+--------------------------------------------
.. automodule:: pywikibot.families.wikiversity_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wikivoyage_family` Module
--------------------------------
+pywikibot.families.wikivoyage_family module
+-------------------------------------------
.. automodule:: pywikibot.families.wikivoyage_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wiktionary_family` Module
--------------------------------
+pywikibot.families.wiktionary_family module
+-------------------------------------------
.. automodule:: pywikibot.families.wiktionary_family
:members:
:undoc-members:
:show-inheritance:
-:mod:`wowwiki_family` Module
-----------------------------
+pywikibot.families.wowwiki_family module
+----------------------------------------
.. automodule:: pywikibot.families.wowwiki_family
:members:
:undoc-members:
:show-inheritance:
-
diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst
index 8af3ac0..c18a64c 100644
--- a/docs/api_ref/pywikibot.rst
+++ b/docs/api_ref/pywikibot.rst
@@ -1,212 +1,7 @@
-pywikibot Package
+pywikibot package
=================
-:mod:`pywikibot` Package
-------------------------
-
-.. automodule:: pywikibot.__init__
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`bot` Module
------------------
-
-.. automodule:: pywikibot.bot
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`botirc` Module
---------------------
-
-.. automodule:: pywikibot.botirc
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`config2` Module
----------------------
-
-.. automodule:: pywikibot.config2
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`date` Module
-------------------
-
-.. automodule:: pywikibot.date
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`diff` Module
-------------------
-
-.. automodule:: pywikibot.diff
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`echo` Module
-------------------
-
-.. automodule:: pywikibot.echo
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`editor` Module
---------------------
-
-.. automodule:: pywikibot.editor
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`exceptions` Module
-------------------------
-
-.. automodule:: pywikibot.exceptions
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`family` Module
---------------------
-
-.. automodule:: pywikibot.family
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`fixes` Module
--------------------
-
-.. automodule:: pywikibot.fixes
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`i18n` Module
-------------------
-
-.. automodule:: pywikibot.i18n
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`interwiki_graph` Module
------------------------------
-
-.. automodule:: pywikibot.interwiki_graph
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`logentries` Module
-------------------------
-
-.. automodule:: pywikibot.logentries
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`login` Module
--------------------
-
-.. automodule:: pywikibot.login
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`page` Module
-------------------
-
-.. automodule:: pywikibot.page
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`pagegenerators` Module
-----------------------------
-
-.. automodule:: pywikibot.pagegenerators
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`plural` Module
---------------------
-
-.. automodule:: pywikibot.plural
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`site` Module
-------------------
-
-.. automodule:: pywikibot.site
- :members:
- :undoc-members:
- :private-members:
- :show-inheritance:
-
-:mod:`textlib` Module
----------------------
-
-.. automodule:: pywikibot.textlib
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`throttle` Module
-----------------------
-
-.. automodule:: pywikibot.throttle
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`titletranslate` Module
-----------------------------
-
-.. automodule:: pywikibot.titletranslate
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`tools` Module
--------------------
-
-.. automodule:: pywikibot.tools
- :members:
- :undoc-members:
- :private-members:
- :show-inheritance:
-
-:mod:`version` Module
----------------------
-
-.. automodule:: pywikibot.version
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`weblib` Module
---------------------
-
-.. automodule:: pywikibot.weblib
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`xmlreader` Module
------------------------
-
-.. automodule:: pywikibot.xmlreader
+.. automodule:: pywikibot
:members:
:undoc-members:
:show-inheritance:
@@ -220,5 +15,232 @@
pywikibot.compat
pywikibot.data
pywikibot.families
+ pywikibot.tools
pywikibot.userinterfaces
+Submodules
+----------
+
+pywikibot.backports module
+--------------------------
+
+.. automodule:: pywikibot.backports
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.bot module
+--------------------
+
+.. automodule:: pywikibot.bot
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.botirc module
+-----------------------
+
+.. automodule:: pywikibot.botirc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.config2 module
+------------------------
+
+.. automodule:: pywikibot.config2
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.cosmetic_changes module
+---------------------------------
+
+.. automodule:: pywikibot.cosmetic_changes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.daemonize module
+--------------------------
+
+.. automodule:: pywikibot.daemonize
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.date module
+---------------------
+
+.. automodule:: pywikibot.date
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.diff module
+---------------------
+
+.. automodule:: pywikibot.diff
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.echo module
+---------------------
+
+.. automodule:: pywikibot.echo
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.editor module
+-----------------------
+
+.. automodule:: pywikibot.editor
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.exceptions module
+---------------------------
+
+.. automodule:: pywikibot.exceptions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.family module
+-----------------------
+
+.. automodule:: pywikibot.family
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.fixes module
+----------------------
+
+.. automodule:: pywikibot.fixes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.i18n module
+---------------------
+
+.. automodule:: pywikibot.i18n
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.interwiki_graph module
+--------------------------------
+
+.. automodule:: pywikibot.interwiki_graph
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.logentries module
+---------------------------
+
+.. automodule:: pywikibot.logentries
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.login module
+----------------------
+
+.. automodule:: pywikibot.login
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.page module
+---------------------
+
+.. automodule:: pywikibot.page
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.pagegenerators module
+-------------------------------
+
+.. automodule:: pywikibot.pagegenerators
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.plural module
+-----------------------
+
+.. automodule:: pywikibot.plural
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.proofreadpage module
+------------------------------
+
+.. automodule:: pywikibot.proofreadpage
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.site module
+---------------------
+
+.. automodule:: pywikibot.site
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.textlib module
+------------------------
+
+.. automodule:: pywikibot.textlib
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.throttle module
+-------------------------
+
+.. automodule:: pywikibot.throttle
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.titletranslate module
+-------------------------------
+
+.. automodule:: pywikibot.titletranslate
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.version module
+------------------------
+
+.. automodule:: pywikibot.version
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.weblib module
+-----------------------
+
+.. automodule:: pywikibot.weblib
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.xmlreader module
+--------------------------
+
+.. automodule:: pywikibot.xmlreader
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst
new file mode 100644
index 0000000..990f665
--- /dev/null
+++ b/docs/api_ref/pywikibot.tools.rst
@@ -0,0 +1,26 @@
+pywikibot.tools package
+=======================
+
+.. automodule:: pywikibot.tools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+pywikibot.tools.chars module
+----------------------------
+
+.. automodule:: pywikibot.tools.chars
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywikibot.tools.ip module
+-------------------------
+
+.. automodule:: pywikibot.tools.ip
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api_ref/pywikibot.userinterfaces.rst
b/docs/api_ref/pywikibot.userinterfaces.rst
index f0f162c..46d46bc 100644
--- a/docs/api_ref/pywikibot.userinterfaces.rst
+++ b/docs/api_ref/pywikibot.userinterfaces.rst
@@ -1,75 +1,74 @@
-userinterfaces Package
-======================
-
-:mod:`userinterfaces` Package
------------------------------
+pywikibot.userinterfaces package
+================================
.. automodule:: pywikibot.userinterfaces
:members:
:undoc-members:
:show-inheritance:
-:mod:`cgi_interface` Module
----------------------------
+Submodules
+----------
+
+pywikibot.userinterfaces.cgi_interface module
+---------------------------------------------
.. automodule:: pywikibot.userinterfaces.cgi_interface
:members:
:undoc-members:
:show-inheritance:
-:mod:`gui` Module
------------------
+pywikibot.userinterfaces.gui module
+-----------------------------------
.. automodule:: pywikibot.userinterfaces.gui
:members:
:undoc-members:
:show-inheritance:
-:mod:`terminal_interface` Module
---------------------------------
+pywikibot.userinterfaces.terminal_interface module
+--------------------------------------------------
.. automodule:: pywikibot.userinterfaces.terminal_interface
:members:
:undoc-members:
:show-inheritance:
-:mod:`terminal_interface_base` Module
--------------------------------------
+pywikibot.userinterfaces.terminal_interface_base module
+-------------------------------------------------------
.. automodule:: pywikibot.userinterfaces.terminal_interface_base
:members:
:undoc-members:
:show-inheritance:
-:mod:`terminal_interface_unix` Module
--------------------------------------
+pywikibot.userinterfaces.terminal_interface_unix module
+-------------------------------------------------------
.. automodule:: pywikibot.userinterfaces.terminal_interface_unix
:members:
:undoc-members:
:show-inheritance:
-:mod:`terminal_interface_win32` Module
---------------------------------------
+pywikibot.userinterfaces.terminal_interface_win32 module
+--------------------------------------------------------
.. automodule:: pywikibot.userinterfaces.terminal_interface_win32
:members:
:undoc-members:
:show-inheritance:
-:mod:`transliteration` Module
------------------------------
+pywikibot.userinterfaces.transliteration module
+-----------------------------------------------
.. automodule:: pywikibot.userinterfaces.transliteration
:members:
:undoc-members:
:show-inheritance:
-:mod:`win32_unicode` Module
----------------------------
+pywikibot.userinterfaces.win32_unicode module
+---------------------------------------------
.. automodule:: pywikibot.userinterfaces.win32_unicode
:members:
:undoc-members:
:show-inheritance:
-
--
To view, visit
https://gerrit.wikimedia.org/r/213979
To unsubscribe, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I3ee161a0927e984dcfeb6656b1588182205d9bb9
Gerrit-PatchSet: 1
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: John Vandenberg <jayvdb(a)gmail.com>
Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com>
Gerrit-Reviewer: Ladsgroup <ladsgroup(a)gmail.com>
Gerrit-Reviewer: Merlijn van Deen <valhallasw(a)arctus.nl>
Gerrit-Reviewer: XZise <CommodoreFabianus(a)gmx.de>
Gerrit-Reviewer: jenkins-bot <>