Xqt has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/818616
)
Change subject: [doc] Expand module index for logging, scripts, site and time module
......................................................................
[doc] Expand module index for logging, scripts, site and time module
Bug: T308063
Change-Id: Id3f1c5e0b5d799e3afce1cff37e4d95fa2fb7d1d
---
M docs/api_ref/pywikibot.rst
M docs/api_ref/pywikibot.site.rst
M docs/conf.py
3 files changed, 29 insertions(+), 1 deletion(-)
Approvals:
jenkins-bot: Verified
Xqt: Looks good to me, approved
diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst
index a12c651..e0e7617 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
---------------------
@@ -104,11 +104,14 @@
.. automodule:: logentries
+.. module:: logging
+
:mod:`logging` module
---------------------
.. automodule:: pywikibot.logging
:member-order: bysource
+ :noindex:
:mod:`login` module
-------------------
@@ -140,10 +143,13 @@
.. automodule:: throttle
+.. :module:: time
+
:mod:`time` module
------------------
.. automodule:: pywikibot.time
+ :noindex:
:mod:`titletranslate` module
----------------------------
diff --git a/docs/api_ref/pywikibot.site.rst b/docs/api_ref/pywikibot.site.rst
index 9c0abe3..8fe9b46 100644
--- a/docs/api_ref/pywikibot.site.rst
+++ b/docs/api_ref/pywikibot.site.rst
@@ -1,49 +1,70 @@
:mod:`site` package
===================
+.. py:module:: site
.. automodule:: pywikibot.site
:no-members:
+ :noindex:
:mod:`BaseSite<pywikibot.site._basesite>` package
-------------------------------------------------
+.. py:module:: site._basesite
.. automodule:: pywikibot.site._basesite
+ :noindex:
+
+.. py:module:: site._apisite
:mod:`APISite<pywikibot.site.\_apisite>` Package
------------------------------------------------
.. automodule:: pywikibot.site._apisite
+ :noindex:
.. automodule:: pywikibot.site._extensions
+ :noindex:
.. automodule:: pywikibot.site._generators
+ :noindex:
:mod:`DataSite<pywikibot.site.\_datasite>` Package
--------------------------------------------------
+.. py:module:: site._datasite
.. automodule:: pywikibot.site._datasite
+ :noindex:
:mod:`Obsolete Sites<pywikibot.site._obsoletesites>` Package
------------------------------------------------------------
+.. py:module:: site._obsoletesites
.. automodule:: pywikibot.site._obsoletesites
+ :noindex:
:mod:`Siteinfo<pywikibot.site._siteinfo>` Package
-------------------------------------------------
+.. py:module:: site._siteinfo
.. automodule:: pywikibot.site._siteinfo
+ :noindex:
:mod:`Namespace<pywikibot.site._namespace>` Package
---------------------------------------------------
+.. py:module:: site._namespace
.. automodule:: pywikibot.site._namespace
+ :noindex:
:mod:`TokenWallet<pywikibot.site._tokenwallet>` Package
-------------------------------------------------------
+.. py:module:: site._tokenwallet
.. automodule:: pywikibot.site._tokenwallet
+ :noindex:
:mod:`Uploader<pywikibot.site._upload>` Package
-----------------------------------------------
+.. py:module:: site._upload
.. automodule:: pywikibot.site._upload
+ :noindex:
diff --git a/docs/conf.py b/docs/conf.py
index a6b12ea..7a3375a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -371,6 +371,7 @@
# Allow lines like "Example:" to be followed by a code block
napoleon_use_admonition_for_examples = True
python_use_unqualified_type_names = True
+modindex_common_prefix = ['pywikibot.scripts.']
# Pywikibot theme style
html_permalinks_icon = '#'
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/818616
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: Id3f1c5e0b5d799e3afce1cff37e4d95fa2fb7d1d
Gerrit-Change-Number: 818616
Gerrit-PatchSet: 1
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged