Xqt has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/760266 )
Change subject: [doc] Add scripts descriptions for bot users
......................................................................
[doc] Add scripts descriptions for bot users
Change-Id: I750e7bca080ff42ca839eaa322455c17a479ce50
---
M docs/index.rst
A docs/scripts/administrative.rst
A docs/scripts/auxiliary.rst
A docs/scripts/categories.rst
A docs/scripts/general.rst
A docs/scripts/global.rst
A docs/scripts/images.rst
M docs/scripts/index.rst
A docs/scripts/main.rst
A docs/scripts/nonedit.rst
A docs/scripts/other.rst
A docs/scripts/templates.rst
A docs/scripts/unsorted.rst
A docs/scripts/wikibase.rst
A docs/scripts_ref/index.rst
A docs/scripts_ref/scripts.archive.rst
A docs/scripts_ref/scripts.i18n.rst
A docs/scripts_ref/scripts.maintenance.rst
R docs/scripts_ref/scripts.rst
A docs/scripts_ref/scripts.userscripts.rst
M scripts/README.rst
21 files changed, 744 insertions(+), 35 deletions(-)
Approvals:
jenkins-bot: Verified
Xqt: Looks good to me, approved
diff --git a/docs/index.rst b/docs/index.rst
index b68cb36..42680c8 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -69,6 +69,7 @@
:maxdepth: 1
scripts/scripts.maintenance
+ scripts_ref/index
Miscellaneous
diff --git a/docs/scripts/administrative.rst b/docs/scripts/administrative.rst
new file mode 100644
index 0000000..7916b44
--- /dev/null
+++ b/docs/scripts/administrative.rst
@@ -0,0 +1,38 @@
+Administrative scripts
+======================
+
+blockpageschecker script
+------------------------
+
+.. automodule:: scripts.blockpageschecker
+ :no-members:
+
+delete script
+-------------
+
+.. automodule:: scripts.delete
+ :no-members:
+
+patrol script
+-------------
+
+.. automodule:: scripts.patrol
+ :no-members:
+
+protect script
+--------------
+
+.. automodule:: scripts.protect
+ :no-members:
+
+revertbot script
+----------------
+
+.. automodule:: scripts.revertbot
+ :no-members:
+
+speedy\_delete script
+---------------------
+
+.. automodule:: scripts.speedy_delete
+ :no-members:
diff --git a/docs/scripts/auxiliary.rst b/docs/scripts/auxiliary.rst
new file mode 100644
index 0000000..1cbae28
--- /dev/null
+++ b/docs/scripts/auxiliary.rst
@@ -0,0 +1,20 @@
+Auxiliary scripts
+=================
+
+clean\_sandbox script
+---------------------
+
+.. automodule:: scripts.clean_sandbox
+ :no-members:
+
+cosmetic\_changes script
+------------------------
+
+.. automodule:: scripts.cosmetic_changes
+ :no-members:
+
+transferbot script
+------------------
+
+.. automodule:: scripts.transferbot
+ :no-members:
diff --git a/docs/scripts/categories.rst b/docs/scripts/categories.rst
new file mode 100644
index 0000000..12fa562
--- /dev/null
+++ b/docs/scripts/categories.rst
@@ -0,0 +1,15 @@
+Categories scripts
+==================
+
+category\_redirect script
+-------------------------
+
+.. automodule:: scripts.category_redirect
+ :no-members:
+
+commonscat script
+-----------------
+
+.. automodule:: scripts.commonscat
+ :no-members:
+
diff --git a/docs/scripts/general.rst b/docs/scripts/general.rst
new file mode 100644
index 0000000..bceead8
--- /dev/null
+++ b/docs/scripts/general.rst
@@ -0,0 +1,20 @@
+General pages changes scripts
+=============================
+
+archivebot script
+-----------------
+
+.. automodule:: scripts.archivebot
+ :no-members:
+
+movepages script
+----------------
+
+.. automodule:: scripts.movepages
+ :no-members:
+
+pagefromfile script
+-------------------
+
+.. automodule:: scripts.pagefromfile
+ :no-members:
diff --git a/docs/scripts/global.rst b/docs/scripts/global.rst
new file mode 100644
index 0000000..4614291
--- /dev/null
+++ b/docs/scripts/global.rst
@@ -0,0 +1,17 @@
+Global bot scripts
+==================
+
+interwiki script
+----------------
+
+Creates or modifies Interlanguage links between projects.
+
+.. automodule:: scripts.interwiki
+ :no-members:
+
+
+redirect script
+---------------
+
+.. automodule:: scripts.redirect
+ :no-members:
diff --git a/docs/scripts/images.rst b/docs/scripts/images.rst
new file mode 100644
index 0000000..390e42d
--- /dev/null
+++ b/docs/scripts/images.rst
@@ -0,0 +1,44 @@
+Images scripts
+==============
+
+checkimages script
+------------------
+
+.. automodule:: scripts.checkimages
+ :no-members:
+
+commons\_information script
+---------------------------
+
+.. automodule:: scripts.commons_information
+ :no-members:
+
+data\_ingestion script
+----------------------
+
+.. automodule:: scripts.data_ingestion
+ :no-members:
+
+image script
+------------
+
+.. automodule:: scripts.image
+ :no-members:
+
+imagetransfer script
+--------------------
+
+.. automodule:: scripts.imagetransfer
+ :no-members:
+
+nowcommons script
+-----------------
+
+.. automodule:: scripts.nowcommons
+ :no-members:
+
+unusedfiles script
+------------------
+
+.. automodule:: scripts.unusedfiles
+ :no-members:
diff --git a/docs/scripts/index.rst b/docs/scripts/index.rst
index 3c14b01..868b105 100644
--- a/docs/scripts/index.rst
+++ b/docs/scripts/index.rst
@@ -1,18 +1,28 @@
-Scripts reference
------------------
+Scripts package
+---------------
-Provided scripts by Pywikibot
-=============================
+.. automodule:: scripts
+ :no-members:
-Pywikibot framework has a lot of ready-to-use scripts for several tasks.
-In general the usage and options of all scripts may be shown by using the
command
-``<scriptname> -help``
+.. include:: ../../scripts/README.rst
+ :start-after: included.
+ :end-before: More precise
-
-Contents
-========
+Scripts descriptions
+--------------------
.. toctree::
- :glob:
+ :maxdepth: 1
- *
+ global
+ main
+ auxiliary
+ administrative
+ general
+ categories
+ images
+ templates
+ wikibase
+ nonedit
+ other
+ unsorted
\ No newline at end of file
diff --git a/docs/scripts/main.rst b/docs/scripts/main.rst
new file mode 100644
index 0000000..9e2af44
--- /dev/null
+++ b/docs/scripts/main.rst
@@ -0,0 +1,38 @@
+Main bot scripts
+================
+
+add\_text script
+----------------
+
+.. automodule:: scripts.add_text
+ :no-members:
+
+category script
+---------------
+
+.. automodule:: scripts.category
+ :no-members:
+
+replace script
+--------------
+
+.. automodule:: scripts.replace
+ :no-members:
+
+solve\_disambiguation script
+----------------------------
+
+.. automodule:: scripts.solve_disambiguation
+ :no-members:
+
+upload script
+-------------
+
+.. automodule:: scripts.upload
+ :no-members:
+
+weblinkchecker script
+---------------------
+
+.. automodule:: scripts.weblinkchecker
+ :no-members:
diff --git a/docs/scripts/nonedit.rst b/docs/scripts/nonedit.rst
new file mode 100644
index 0000000..62e3cfd
--- /dev/null
+++ b/docs/scripts/nonedit.rst
@@ -0,0 +1,14 @@
+Non editing scripts
+===================
+
+listpages script
+----------------
+
+.. automodule:: scripts.listpages
+ :no-members:
+
+touch script
+------------
+
+.. automodule:: scripts.touch
+ :no-members:
diff --git a/docs/scripts/other.rst b/docs/scripts/other.rst
new file mode 100644
index 0000000..620aeda
--- /dev/null
+++ b/docs/scripts/other.rst
@@ -0,0 +1,8 @@
+Other bot scripts
+=================
+
+welcome script
+--------------
+
+.. automodule:: scripts.welcome
+ :no-members:
diff --git a/docs/scripts/templates.rst b/docs/scripts/templates.rst
new file mode 100644
index 0000000..1625bbf
--- /dev/null
+++ b/docs/scripts/templates.rst
@@ -0,0 +1,14 @@
+Template scripts
+================
+
+template script
+---------------
+
+.. automodule:: scripts.template
+ :no-members:
+
+templatecount script
+--------------------
+
+.. automodule:: scripts.templatecount
+ :no-members:
diff --git a/docs/scripts/unsorted.rst b/docs/scripts/unsorted.rst
new file mode 100644
index 0000000..cf16c38
--- /dev/null
+++ b/docs/scripts/unsorted.rst
@@ -0,0 +1,362 @@
+.. toctree::
+ :titlesonly:
+
+ Global bot scripts
+ Main bot scripts
+ Auxiliary scripts
+ Administrative scripts
+ Change general pages
+ Categories scripts
+ Images scripts
+ Template scripts
+ Wikibase scripts
+ Non editing scripts
+ Other bot scripts
+ Unsorted scripts
+
+Global bot scripts
+==================
+
+interwiki script
+----------------
+
+Creates or modifies Interlanguage links between projects.
+
+.. automodule:: scripts.interwiki
+ :no-members:
+
+
+redirect script
+---------------
+
+.. automodule:: scripts.redirect
+ :no-members:
+
+Main bot scripts
+================
+
+add\_text script
+----------------
+
+.. automodule:: scripts.add_text
+ :no-members:
+
+category script
+---------------
+
+.. automodule:: scripts.category
+ :no-members:
+
+replace script
+--------------
+
+.. automodule:: scripts.replace
+ :no-members:
+
+solve\_disambiguation script
+----------------------------
+
+.. automodule:: scripts.solve_disambiguation
+ :no-members:
+
+upload script
+-------------
+
+.. automodule:: scripts.upload
+ :no-members:
+
+weblinkchecker script
+---------------------
+
+.. automodule:: scripts.weblinkchecker
+ :no-members:
+
+Auxiliary scripts
+=================
+
+clean\_sandbox script
+---------------------
+
+.. automodule:: scripts.clean_sandbox
+ :no-members:
+
+cosmetic\_changes script
+------------------------
+
+.. automodule:: scripts.cosmetic_changes
+ :no-members:
+
+transferbot script
+------------------
+
+.. automodule:: scripts.transferbot
+ :no-members:
+
+Administrative scripts
+======================
+
+blockpageschecker script
+------------------------
+
+.. automodule:: scripts.blockpageschecker
+ :no-members:
+
+delete script
+-------------
+
+.. automodule:: scripts.delete
+ :no-members:
+
+patrol script
+-------------
+
+.. automodule:: scripts.patrol
+ :no-members:
+
+protect script
+--------------
+
+.. automodule:: scripts.protect
+ :no-members:
+
+revertbot script
+----------------
+
+.. automodule:: scripts.revertbot
+ :no-members:
+
+speedy\_delete script
+---------------------
+
+.. automodule:: scripts.speedy_delete
+ :no-members:
+
+Change general pages
+====================
+
+archivebot script
+-----------------
+
+.. automodule:: scripts.archivebot
+ :no-members:
+
+movepages script
+----------------
+
+.. automodule:: scripts.movepages
+ :no-members:
+
+pagefromfile script
+-------------------
+
+.. automodule:: scripts.pagefromfile
+ :no-members:
+
+Categories scripts
+==================
+
+category\_redirect script
+-------------------------
+
+.. automodule:: scripts.category_redirect
+ :no-members:
+
+commonscat script
+-----------------
+
+.. automodule:: scripts.commonscat
+ :no-members:
+
+Images scripts
+==============
+
+checkimages script
+------------------
+
+.. automodule:: scripts.checkimages
+ :no-members:
+
+commons\_information script
+---------------------------
+
+.. automodule:: scripts.commons_information
+ :no-members:
+
+data\_ingestion script
+----------------------
+
+.. automodule:: scripts.data_ingestion
+ :no-members:
+
+image script
+------------
+
+.. automodule:: scripts.image
+ :no-members:
+
+imagetransfer script
+--------------------
+
+.. automodule:: scripts.imagetransfer
+ :no-members:
+
+nowcommons script
+-----------------
+
+.. automodule:: scripts.nowcommons
+ :no-members:
+
+unusedfiles script
+------------------
+
+.. automodule:: scripts.unusedfiles
+ :no-members:
+
+Template scripts
+================
+
+template script
+---------------
+
+.. automodule:: scripts.template
+ :no-members:
+
+templatecount script
+--------------------
+
+.. automodule:: scripts.templatecount
+ :no-members:
+
+Wikibase scripts
+================
+
+claimit script
+--------------
+
+.. automodule:: scripts.claimit
+ :no-members:
+
+harvest\_template script
+------------------------
+
+.. automodule:: scripts.harvest_template
+ :no-members:
+
+illustrate\_wikidata script
+---------------------------
+
+.. automodule:: scripts.illustrate_wikidata
+ :no-members:
+
+interwikidata script
+--------------------
+
+.. automodule:: scripts.interwikidata
+ :no-members:
+
+newitem script
+--------------
+
+.. automodule:: scripts.newitem
+ :no-members:
+
+Non editing scripts
+===================
+
+listpages script
+----------------
+
+.. automodule:: scripts.listpages
+ :no-members:
+
+touch script
+------------
+
+.. automodule:: scripts.touch
+ :no-members:
+
+Other bot scripts
+=================
+
+welcome script
+--------------
+
+.. automodule:: scripts.welcome
+ :no-members:
+
+Unsorted scripts
+================
+
+basic script
+------------
+
+.. automodule:: scripts.basic
+ :no-members:
+
+change\_pagelang script
+-----------------------
+
+.. automodule:: scripts.change_pagelang
+ :no-members:
+
+coordinate\_import script
+-------------------------
+
+.. automodule:: scripts.coordinate_import
+ :no-members:
+
+djvutext script
+---------------
+.. automodule:: scripts.djvutext
+ :no-members:
+
+download\_dump script
+---------------------
+
+.. automodule:: scripts.download_dump
+ :no-members:
+
+fixing\_redirects script
+------------------------
+
+.. automodule:: scripts.fixing_redirects
+ :no-members:
+
+misspelling script
+------------------
+
+.. automodule:: scripts.misspelling
+ :no-members:
+
+noreferences script
+-------------------
+
+.. automodule:: scripts.noreferences
+ :no-members:
+
+
+parser\_function\_count script
+------------------------------
+
+.. automodule:: scripts.parser_function_count
+ :no-members:
+
+
+reflinks script
+---------------
+
+.. automodule:: scripts.reflinks
+ :no-members:
+
+replicate\_wiki script
+----------------------
+
+.. automodule:: scripts.replicate_wiki
+ :no-members:
+
+
+watchlist script
+----------------
+
+.. automodule:: scripts.watchlist
+ :no-members:
diff --git a/docs/scripts/wikibase.rst b/docs/scripts/wikibase.rst
new file mode 100644
index 0000000..8e99816
--- /dev/null
+++ b/docs/scripts/wikibase.rst
@@ -0,0 +1,32 @@
+Wikibase scripts
+================
+
+claimit script
+--------------
+
+.. automodule:: scripts.claimit
+ :no-members:
+
+harvest\_template script
+------------------------
+
+.. automodule:: scripts.harvest_template
+ :no-members:
+
+illustrate\_wikidata script
+---------------------------
+
+.. automodule:: scripts.illustrate_wikidata
+ :no-members:
+
+interwikidata script
+--------------------
+
+.. automodule:: scripts.interwikidata
+ :no-members:
+
+newitem script
+--------------
+
+.. automodule:: scripts.newitem
+ :no-members:
diff --git a/docs/scripts_ref/index.rst b/docs/scripts_ref/index.rst
new file mode 100644
index 0000000..3c14b01
--- /dev/null
+++ b/docs/scripts_ref/index.rst
@@ -0,0 +1,18 @@
+Scripts reference
+-----------------
+
+Provided scripts by Pywikibot
+=============================
+
+Pywikibot framework has a lot of ready-to-use scripts for several tasks.
+In general the usage and options of all scripts may be shown by using the
command
+``<scriptname> -help``
+
+
+Contents
+========
+
+.. toctree::
+ :glob:
+
+ *
diff --git a/docs/scripts_ref/scripts.archive.rst
b/docs/scripts_ref/scripts.archive.rst
new file mode 100644
index 0000000..79c34d1
--- /dev/null
+++ b/docs/scripts_ref/scripts.archive.rst
@@ -0,0 +1,4 @@
+scripts.archive archived scripts
+================================
+
+.. automodule:: scripts.archive
\ No newline at end of file
diff --git a/docs/scripts_ref/scripts.i18n.rst
b/docs/scripts_ref/scripts.i18n.rst
new file mode 100644
index 0000000..20aa2a0
--- /dev/null
+++ b/docs/scripts_ref/scripts.i18n.rst
@@ -0,0 +1,4 @@
+scripts.i18n translation files
+==============================
+
+.. automodule:: scripts.i18n
\ No newline at end of file
diff --git a/docs/scripts_ref/scripts.maintenance.rst
b/docs/scripts_ref/scripts.maintenance.rst
new file mode 100644
index 0000000..e7bb9c4
--- /dev/null
+++ b/docs/scripts_ref/scripts.maintenance.rst
@@ -0,0 +1,44 @@
+scripts.maintenance utility scripts
+===================================
+
+.. automodule:: scripts.maintenance
+
+Submodules
+----------
+
+scripts.maintenance.cache script
+--------------------------------
+
+.. automodule:: scripts.maintenance.cache
+ :ignore-module-all:
+
+scripts.maintenance.colors script
+---------------------------------
+
+.. automodule:: scripts.maintenance.colors
+
+scripts.maintenance.make\_i18n\_dict script
+-------------------------------------------
+
+.. automodule:: scripts.maintenance.make_i18n_dict
+
+scripts.maintenance.preload_sites script
+-----------------------------------------
+
+.. automodule:: scripts.maintenance.preload_sites
+
+scripts.maintenance.sorting\_order script
+-----------------------------------------
+
+.. automodule:: scripts.maintenance.sorting_order
+
+scripts.maintenance.update\_linktrails script
+---------------------------------------------
+
+.. automodule:: scripts.maintenance.update_linktrails
+
+scripts.maintenance.wikimedia\_sites script
+-------------------------------------------
+
+.. automodule:: scripts.maintenance.wikimedia_sites
+
diff --git a/docs/scripts/scripts.rst b/docs/scripts_ref/scripts.rst
similarity index 100%
rename from docs/scripts/scripts.rst
rename to docs/scripts_ref/scripts.rst
diff --git a/docs/scripts_ref/scripts.userscripts.rst
b/docs/scripts_ref/scripts.userscripts.rst
new file mode 100644
index 0000000..60ac1d4
--- /dev/null
+++ b/docs/scripts_ref/scripts.userscripts.rst
@@ -0,0 +1,5 @@
+scripts.userscripts user scripts
+================================
+
+.. automodule:: scripts.userscripts
+
diff --git a/scripts/README.rst b/scripts/README.rst
index 2e6e489..2d6f80c 100644
--- a/scripts/README.rst
+++ b/scripts/README.rst
@@ -154,6 +154,29 @@
+------------------------+---------------------------------------------------------+
+ | maintenance | Framework helper scripts. .
|
+
+========================+=========================================================+
+ | cache.py | Script for showing and deleting API cache.
|
+
+------------------------+---------------------------------------------------------+
+ | colors.py | Utility to show pywikibot colors.
|
+
+------------------------+---------------------------------------------------------+
+ | update_script.py | Helper script to update scripts and replace
deprecated |
+ | | code parts.
|
+
+------------------------+---------------------------------------------------------+
+ | make_i18n_dict.py | Generate an i18n file from a given script.
|
+
+------------------------+---------------------------------------------------------+
+ | preload_sites.py | Preload and cache site information for each
WikiMedia |
+ | | family. Usefull for bots running on multiple
sites. |
+
+------------------------+---------------------------------------------------------+
+ | sorting_order.py | Updates interwiki sorting order in family.py
file. |
+
+------------------------+---------------------------------------------------------+
+ | update_linktrails.py | Script that updates the linktrails in family.py
file. |
+
+------------------------+---------------------------------------------------------+
+ | wikimedia_sites.py | Updates the language lists in Wikimedia family
files. |
+
+------------------------+---------------------------------------------------------+
+
+
+
+------------------------+---------------------------------------------------------+
| archive | Scripts no longer maintained.
|
| | Please open a Phabricator task if you want to
use one. |
+========================+=========================================================+
@@ -235,29 +258,7 @@
+------------------------+---------------------------------------------------------+
- | maintenance | Framework helper scripts.
|
-
+========================+=========================================================+
- | cache.py | Script for showing and deleting API cache.
|
-
+------------------------+---------------------------------------------------------+
- | colors.py | Utility to show pywikibot colors.
|
-
+------------------------+---------------------------------------------------------+
- | update_script.py | Helper script to update scripts and replace
deprecated |
- | | code parts.
|
-
+------------------------+---------------------------------------------------------+
- | make_i18n_dict.py | Generate an i18n file from a given script.
|
-
+------------------------+---------------------------------------------------------+
- | preload_sites.py | Preload and cache site information for each WM
family. |
-
+------------------------+---------------------------------------------------------+
- | sorting_order.py | Updates interwiki sorting order in family.py
file. |
-
+------------------------+---------------------------------------------------------+
- | update_linktrails.py | Script that updates the linktrails in family.py
file. |
-
+------------------------+---------------------------------------------------------+
- | wikimedia_sites.py | Updates the language lists in Wikimedia family
files. |
-
+------------------------+---------------------------------------------------------+
-
-
-
+----------------------------------------------------------------------------------+
- | Others
|
+ | Others |
|
+========================+=========================================================+
| i18n (folder) | Contains i18n translations for bot edit
summaries. |
+------------------------+---------------------------------------------------------+
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/760266
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: I750e7bca080ff42ca839eaa322455c17a479ce50
Gerrit-Change-Number: 760266
Gerrit-PatchSet: 2
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]
