jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/365204 )

Change subject: [DOC] Add scripts file to docs ......................................................................

[DOC] Add scripts file to docs

Bug: T109557 Change-Id: I98be53c8a32f8fdc019731aac592bff19202c290 --- A docs/scripts/index.rst A docs/scripts/scripts.i18n.rst A docs/scripts/scripts.maintenance.rst A docs/scripts/scripts.rst 4 files changed, 801 insertions(+), 0 deletions(-)

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

diff --git a/docs/scripts/index.rst b/docs/scripts/index.rst new file mode 100644 index 0000000..c5b1d6e --- /dev/null +++ b/docs/scripts/index.rst @@ -0,0 +1,20 @@ +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/scripts.i18n.rst b/docs/scripts/scripts.i18n.rst new file mode 100644 index 0000000..e2ed902 --- /dev/null +++ b/docs/scripts/scripts.i18n.rst @@ -0,0 +1,8 @@ +scripts.i18n translation files +============================== + +.. automodule:: scripts.i18n + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/scripts/scripts.maintenance.rst b/docs/scripts/scripts.maintenance.rst new file mode 100644 index 0000000..0efc042 --- /dev/null +++ b/docs/scripts/scripts.maintenance.rst @@ -0,0 +1,54 @@ +scripts.maintenance utility scripts +=================================== + +.. automodule:: scripts.maintenance + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +scripts.maintenance.cache script +-------------------------------- + +.. automodule:: scripts.maintenance.cache + :members: + :undoc-members: + :show-inheritance: + + +scripts.maintenance.colors script +--------------------------------- + +.. automodule:: scripts.maintenance.colors + :members: + :undoc-members: + :show-inheritance: + + +scripts.maintenance.compat2core script +-------------------------------------- + +.. automodule:: scripts.maintenance.compat2core + :members: + :undoc-members: + :show-inheritance: + + +scripts.maintenance.make_i18n_dict script +----------------------------------------- + +.. automodule:: scripts.maintenance.make_i18n_dict + :members: + :undoc-members: + :show-inheritance: + + +scripts.maintenance.wikimedia_sites script +----------------------------------------- + +.. automodule:: scripts.maintenance.wikimedia_sites + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/scripts/scripts.rst b/docs/scripts/scripts.rst new file mode 100644 index 0000000..b500bb4 --- /dev/null +++ b/docs/scripts/scripts.rst @@ -0,0 +1,719 @@ +user scripts package +==================== + +.. automodule:: scripts + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + scripts.i18n + scripts.maintenance + +Submodules +---------- + +scripts.add_text script +----------------------- + +.. automodule:: script.add_text + :members: + :undoc-members: + :show-inheritance: + + +scripts.archivebot script +------------------------- + +.. automodule:: script.archivebot + :members: + :undoc-members: + :show-inheritance: + + +scripts.basic script +-------------------- + +.. automodule:: script.basic + :members: + :undoc-members: + :show-inheritance: + + +scripts.blockpagechecker script +------------------------------- + +.. automodule:: script.blockpagechecker + :members: + :undoc-members: + :show-inheritance: + + +scripts.capitalize_redirects script +----------------------------------- + +.. automodule:: script.capitalize_redirects + :members: + :undoc-members: + :show-inheritance: + + +scripts.catall script +--------------------- + +.. automodule:: script.catall + :members: + :undoc-members: + :show-inheritance: + + +scripts.category script +----------------------- + +.. automodule:: script.category + :members: + :undoc-members: + :show-inheritance: + + +scripts.cfd script +------------------ + +.. automodule:: script.cfd + :members: + :undoc-members: + :show-inheritance: + + +scripts.checkimages script +-------------------------- + +.. automodule:: script.checkimages + :members: + :undoc-members: + :show-inheritance: + + +scripts.claimit script +---------------------- + +.. automodule:: script.claimit + :members: + :undoc-members: + :show-inheritance: + + +scripts.clean_sandbox script +---------------------------- + +.. automodule:: script.clean_sandboy + :members: + :undoc-members: + :show-inheritance: + + +scripts.commons_link script +--------------------------- + +.. automodule:: script.commons_link + :members: + :undoc-members: + :show-inheritance: + + +scripts.commonscat script +------------------------- + +.. automodule:: script.commonscat + :members: + :undoc-members: + :show-inheritance: + + +scripts.coodinate_import script +------------------------------- + +.. automodule:: script.coodinate_import + :members: + :undoc-members: + :show-inheritance: + + +scripts.cosmetic_changes script +------------------------------- + +.. automodule:: script.cosmetic_changes + :members: + :undoc-members: + :show-inheritance: + + +scripts.create_categories script +-------------------------------- + +.. automodule:: script.create_categories + :members: + :undoc-members: + :show-inheritance: + + +scripts.data_ingestion script +----------------------------- + +.. automodule:: script.data_ingestion + :members: + :undoc-members: + :show-inheritance: + + +scripts.delete script +--------------------- + +.. automodule:: script.delete + :members: + :undoc-members: + :show-inheritance: + + +scripts.disambredir script +-------------------------- + +.. automodule:: script.disambredir + :members: + :undoc-members: + :show-inheritance: + + +scripts.djvutext script +----------------------- + +.. automodule:: script.djvutext + :members: + :undoc-members: + :show-inheritance: + + +scripts.editarticle script +-------------------------- + +.. automodule:: script.editarticle + :members: + :undoc-members: + :show-inheritance: + + +scripts.fixing_redirects script +------------------------------- + +.. automodule:: script.fixing_redirects + :members: + :undoc-members: + :show-inheritance: + + +scripts.flickrripper script +--------------------------- + +.. automodule:: script.flickrripper + :members: + :undoc-members: + :show-inheritance: + + +scripts.followlive script +------------------------- + +.. automodule:: script.followlive + :members: + :undoc-members: + :show-inheritance: + + +scripts.freebasemappingupload script +------------------------------------ + +.. automodule:: script.freebasemappingupload + :members: + :undoc-members: + :show-inheritance: + + +scripts.harvest_template script +------------------------------- + +.. automodule:: script.harvest_template + :members: + :undoc-members: + :show-inheritance: + + +scripts.illustrate_wikidata script +---------------------------------- + +.. automodule:: script.illustrate_wikidata + :members: + :undoc-members: + :show-inheritance: + + +scripts.image script +-------------------- + +.. automodule:: script.image + :members: + :undoc-members: + :show-inheritance: + + +scripts.imagecopy script +------------------------ + +.. automodule:: script.imagecopy + :members: + :undoc-members: + :show-inheritance: + + +scripts.imagecopy_self script +----------------------------- + +.. automodule:: script.imagecopy_self + :members: + :undoc-members: + :show-inheritance: + + +scripts.imageharvest script +--------------------------- + +.. automodule:: script.imageharvest + :members: + :undoc-members: + :show-inheritance: + + +scripts.imagerecat script +------------------------- + +.. automodule:: script.imagerecat + :members: + :undoc-members: + :show-inheritance: + + +scripts.imagetransfer script +---------------------------- + +.. automodule:: script.imagetransfer + :members: + :undoc-members: + :show-inheritance: + + +scripts.imageuncat script +------------------------- + +.. automodule:: script.imageuncat + :members: + :undoc-members: + :show-inheritance: + + +scripts.interwiki script +------------------------ + +.. automodule:: script.interwiki + :members: + :undoc-members: + :show-inheritance: + + +scripts.interwikidata script +---------------------------- + +.. automodule:: script.interwikidata + :members: + :undoc-members: + :show-inheritance: + + +scripts.isbn script +------------------- + +.. automodule:: script.isbn + :members: + :undoc-members: + :show-inheritance: + + +scripts.listpages script +------------------------ + +.. automodule:: script.listpages + :members: + :undoc-members: + :show-inheritance: + + +scripts.login script +-------------------- + +.. automodule:: script.login + :members: + :undoc-members: + :show-inheritance: + + +scripts.lonelypages script +-------------------------- + +.. automodule:: script.lonelypages + :members: + :undoc-members: + :show-inheritance: + + +scripts.makecat script +---------------------- + +.. automodule:: script.makecat + :members: + :undoc-members: + :show-inheritance: + + +scripts.match_images script +--------------------------- + +.. automodule:: script.match_images + :members: + :undoc-members: + :show-inheritance: + + +scripts.misspelling script +-------------------------- + +.. automodule:: script.misspelling + :members: + :undoc-members: + :show-inheritance: + + +scripts.movepages script +------------------------ + +.. automodule:: script.movepages + :members: + :undoc-members: + :show-inheritance: + + +scripts.ndashredir script +------------------------- + +.. automodule:: script.ndashredir + :members: + :undoc-members: + :show-inheritance: + + +scripts.newitem script +---------------------- + +.. automodule:: script.newitem + :members: + :undoc-members: + :show-inheritance: + + +scripts.noreferences script +--------------------------- + +.. automodule:: script.noreferences + :members: + :undoc-members: + :show-inheritance: + + +scripts.nowcommons script +------------------------- + +.. automodule:: script.nowcommons + :members: + :undoc-members: + :show-inheritance: + + +scripts.pagefromfile script +--------------------------- + +.. automodule:: script.pagefromfile + :members: + :undoc-members: + :show-inheritance: + + +scripts.patrol script +--------------------- + +.. automodule:: script.patrol + :members: + :undoc-members: + :show-inheritance: + + +scripts.piper script +-------------------- + +.. automodule:: script.piper + :members: + :undoc-members: + :show-inheritance: + + +scripts.protect script +---------------------- + +.. automodule:: script.protect + :members: + :undoc-members: + :show-inheritance: + + +scripts.redirect script +----------------------- + +.. automodule:: script.redirect + :members: + :undoc-members: + :show-inheritance: + + +scripts.reflinks script +----------------------- + +.. automodule:: script.reflinks + :members: + :undoc-members: + :show-inheritance: + + +scripts.replace script +---------------------- + +.. automodule:: script.replace + :members: + :undoc-members: + :show-inheritance: + + +scripts.replicate_wiki script +----------------------------- + +.. automodule:: script.replicate_wiki + :members: + :undoc-members: + :show-inheritance: + + +scripts.revertbot script +------------------------ + +.. automodule:: script.revertbot + :members: + :undoc-members: + :show-inheritance: + + +scripts.script_wui script +------------------------- + +.. automodule:: script.script_wui + :members: + :undoc-members: + :show-inheritance: + + +scripts.selflink script +----------------------- + +.. automodule:: script.selflink + :members: + :undoc-members: + :show-inheritance: + + +scripts.shell script +-------------------- + +.. automodule:: script.shell + :members: + :undoc-members: + :show-inheritance: + + +scripts.solve_disambiguation script +----------------------------------- + +.. automodule:: script.solve_disambiguation + :members: + :undoc-members: + :show-inheritance: + + +scripts.spamremove script +------------------------- + +.. automodule:: script.spamremove + :members: + :undoc-members: + :show-inheritance: + + +scripts.standardize_interwiki script +------------------------------------ + +.. automodule:: script.standardize_interwiki + :members: + :undoc-members: + :show-inheritance: + + +scripts.states_redirect script +------------------------------ + +.. automodule:: script.states_redirect + :members: + :undoc-members: + :show-inheritance: + + +scripts.surnames_redirect script +-------------------------------- + +.. automodule:: script.surnames_redirect + :members: + :undoc-members: + :show-inheritance: + + +scripts.table2wiki script +------------------------- + +.. automodule:: script.table2wiki + :members: + :undoc-members: + :show-inheritance: + + +scripts.template script +----------------------- + +.. automodule:: script.template + :members: + :undoc-members: + :show-inheritance: + + +scripts.templatecount script +---------------------------- + +.. automodule:: script.templatecount + :members: + :undoc-members: + :show-inheritance: + + +scripts.touch script +-------------------- + +.. automodule:: script.touch + :members: + :undoc-members: + :show-inheritance: + + +scripts.transferbot script +-------------------------- + +.. automodule:: script.transferbot + :members: + :undoc-members: + :show-inheritance: + + +scripts.unlink script +--------------------- + +.. automodule:: script.unlink + :members: + :undoc-members: + :show-inheritance: + + +scripts.unusedfiles script +-------------------------- + +.. automodule:: script.unusedfiles + :members: + :undoc-members: + :show-inheritance: + + +scripts.upload script +--------------------- + +.. automodule:: script.upload + :members: + :undoc-members: + :show-inheritance: + + +scripts.version script +---------------------- + +.. automodule:: script.version + :members: + :undoc-members: + :show-inheritance: + + +scripts.watchlist script +------------------------ + +.. automodule:: script.watchlist + :members: + :undoc-members: + :show-inheritance: + + +scripts.weblinkchecker script +----------------------------- + +.. automodule:: script.weblinkchecker + :members: + :undoc-members: + :show-inheritance: + + +scripts.welcome script +---------------------- + +.. automodule:: script.welcome + :members: + :undoc-members: + :show-inheritance: + + +scripts.wikisourcetext script +----------------------------- + +.. automodule:: script.wikisourcetext + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file