[Pywikibot-commits] [Gerrit] ...core[tests]: [doc] Clean up content structure and unify headline syntax

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/861831 )

Change subject: [doc] Clean up content structure and unify headline syntax ......................................................................

[doc] Clean up content structure and unify headline syntax

* ensure index page headlines start with # with overline * ensure non-index page headlines start with * with overline * split i18n.rst to two files, creating a dedicated one for i18n plural * remove unnecessary sections (e.g. in pywikibot.page.rst) * change language from console to text in literalinclude in global_options.rst to ensure better contrast in Furo * shorten section headings in docs/scripts where possible * fix text and capitalization in some headlines * this patch excludes content of docs/tests_ref (except docs/tests_ref/ index) for now

Bug: T323812 Change-Id: I8252da0c1ff9c1cb79ec4f5c7cc11db31d456ae1 --- M docs/api_ref/reader.rst M docs/api_ref/iw_titletranslate.rst M docs/api_ref/pywikibot.specialbots.rst M docs/getting_help.rst M docs/scripts/other.rst M docs/scripts/general.rst M docs/api_ref/cosmetic_changes.rst M docs/api_ref/pywikibot.rst M docs/scripts_ref/scripts.maintenance.rst M docs/api_ref/diff.rst M docs/glossary.rst M docs/api_ref/daemonize.rst M docs/api_ref/date_time.rst M docs/scripts_ref/index.rst M docs/api_ref/flow.rst M docs/scripts_ref/scripts.rst M docs/api_ref/logging.rst M docs/scripts/wikibase.rst M docs/api_ref/pywikibot.config.rst M docs/scripts/administrative.rst M docs/scripts/main.rst M docs/mwapi.rst A docs/api_ref/i18n_plural.rst M docs/utilities/scripts.rst M docs/api_ref/site_detect.rst M docs/installation.rst M docs/api_ref/pywikibot.site.rst M docs/scripts/archive.rst M docs/scripts/index.rst M docs/licenses.rst M docs/api_ref/version.rst M docs/api_ref/iw_interwiki_graph.rst M docs/api_ref/proofreadpage.rst M docs/scripts/templates.rst M docs/api_ref/exceptions.rst M docs/faq.rst M docs/scripts_ref/scripts.userscripts.rst M docs/api_ref/date.rst M docs/api_ref/throttle.rst M docs/scripts/categories.rst M docs/api_ref/family.rst M docs/scripts/unsorted.rst M docs/recipes.rst M docs/api_ref/echo.rst M docs/index.rst M docs/api_ref/index.rst M docs/global_options.rst M docs/utilities/scripts_ref.rst M docs/scripts/images.rst M docs/api_ref/pywikibot.comms.rst M docs/api_ref/textlib.rst M docs/api_ref/logentries.rst M docs/api_ref/bot.rst M docs/scripts_ref/scripts.i18n.rst M docs/scripts/global.rst M docs/api_ref/editor.rst M docs/api_ref/pywikibot.tools.rst M docs/api_ref/pywikibot.page.rst M docs/scripts/outdated.rst M docs/api_ref/login.rst M docs/credits.rst M docs/tests_ref/index.rst M docs/api_ref/pywikibot.families.rst M docs/scripts/auxiliary.rst M docs/scripts/maintenance.rst M docs/scripts/nonedit.rst M docs/api_ref/i18n.rst M docs/api_ref/bot_choice.rst M docs/api_ref/pywikibot.data.rst M docs/utilities/install.rst M docs/api_ref/pywikibot.pagegenerators.rst M docs/api_ref/pywikibot.userinterfaces.rst M docs/api_ref/x_backports.rst M docs/api_ref/fixes.rst 74 files changed, 502 insertions(+), 409 deletions(-)

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

diff --git a/docs/api_ref/bot.rst b/docs/api_ref/bot.rst index 12c5f10..6901de0 100644 --- a/docs/api_ref/bot.rst +++ b/docs/api_ref/bot.rst @@ -1,5 +1,6 @@ +**************************************** :mod:`bot` --- Classes for Building Bots ----------------------------------------- +****************************************

.. automodule:: bot :synopsis: User-interface related functions for building bots diff --git a/docs/api_ref/bot_choice.rst b/docs/api_ref/bot_choice.rst index 652b57f..7e0585f 100644 --- a/docs/api_ref/bot_choice.rst +++ b/docs/api_ref/bot_choice.rst @@ -1,5 +1,6 @@ +********************************************* :mod:`bot_choice` --- UI Options and Choices ---------------------------------------------- +*********************************************

.. automodule:: bot_choice :synopsis: Options and Choices for :func:`pywikibot.input_choice` diff --git a/docs/api_ref/cosmetic_changes.rst b/docs/api_ref/cosmetic_changes.rst index 9f25a8d..5f19c47 100644 --- a/docs/api_ref/cosmetic_changes.rst +++ b/docs/api_ref/cosmetic_changes.rst @@ -1,5 +1,6 @@ +********************************************************* :mod:`cosmetic_changes` --- Cosmetic Changes of Wikitext ---------------------------------------------------------- +*********************************************************

.. automodule:: cosmetic_changes :synopsis: This module can do slight modifications to tidy a wiki page's source code diff --git a/docs/api_ref/daemonize.rst b/docs/api_ref/daemonize.rst index af1b7c5..5f7c140 100644 --- a/docs/api_ref/daemonize.rst +++ b/docs/api_ref/daemonize.rst @@ -1,5 +1,6 @@ +********************************************************** :mod:`daemonize` --- Daemonize Current Process (Unix only) ----------------------------------------------------------- +**********************************************************

.. automodule:: daemonize :synopsis: Module to daemonize the current process on Unix. diff --git a/docs/api_ref/date.rst b/docs/api_ref/date.rst index 2ecacf4..3ecc27b 100644 --- a/docs/api_ref/date.rst +++ b/docs/api_ref/date.rst @@ -1,5 +1,6 @@ +****************************************** :mod:`date` --- Date Classes and Functions ------------------------------------------- +******************************************

.. automodule:: date :synopsis: Date data and manipulation module diff --git a/docs/api_ref/date_time.rst b/docs/api_ref/date_time.rst index 84832a0..7741b6e 100644 --- a/docs/api_ref/date_time.rst +++ b/docs/api_ref/date_time.rst @@ -1,4 +1,5 @@ +****************************************** :mod:`time` --- Time Classes and Functions ------------------------------------------- +******************************************

.. automodule:: pywikibot.time diff --git a/docs/api_ref/diff.rst b/docs/api_ref/diff.rst index c6f5641..fe31757 100644 --- a/docs/api_ref/diff.rst +++ b/docs/api_ref/diff.rst @@ -1,5 +1,6 @@ -:mod:`diff` --- Helpers for computing deltas --------------------------------------------- +******************************************** +:mod:`diff` --- Helpers for computing deltas +********************************************

.. automodule:: diff :synopsis: Diff module diff --git a/docs/api_ref/echo.rst b/docs/api_ref/echo.rst index 30201b4..3dc0fc7 100644 --- a/docs/api_ref/echo.rst +++ b/docs/api_ref/echo.rst @@ -1,5 +1,6 @@ +**************************************************** :mod:`echo` --- Echo Extension Classes and functions ----------------------------------------------------- +****************************************************

.. automodule:: echo :synopsis: Classes and functions for working with the Echo extension diff --git a/docs/api_ref/editor.rst b/docs/api_ref/editor.rst index d2df798..b39f973 100644 --- a/docs/api_ref/editor.rst +++ b/docs/api_ref/editor.rst @@ -1,5 +1,6 @@ +*********************************** :mod:`editor` --- Text editor class ------------------------------------ +***********************************

.. automodule:: editor :synopsis: Text editor class for your favourite editor diff --git a/docs/api_ref/exceptions.rst b/docs/api_ref/exceptions.rst index 7e37052..c09ae56 100644 --- a/docs/api_ref/exceptions.rst +++ b/docs/api_ref/exceptions.rst @@ -1,5 +1,6 @@ +**************************************************** :mod:`exceptions` --- Exceptions and Warning Classes ----------------------------------------------------- +****************************************************

.. automodule:: exceptions :synopsis: Pywikibot exceptions and warning classes diff --git a/docs/api_ref/family.rst b/docs/api_ref/family.rst index 316feb1..042b337 100644 --- a/docs/api_ref/family.rst +++ b/docs/api_ref/family.rst @@ -1,5 +1,6 @@ +************************************ :mod:`family` --- MediaWiki families ------------------------------------- +************************************

.. automodule:: family :synopsis: Objects representing MediaWiki families diff --git a/docs/api_ref/fixes.rst b/docs/api_ref/fixes.rst index 657e5ba..1699066 100644 --- a/docs/api_ref/fixes.rst +++ b/docs/api_ref/fixes.rst @@ -1,5 +1,6 @@ +***************************************************** :mod:`fixes` --- standard fixes for replace.py script ------------------------------------------------------ +*****************************************************

.. automodule:: fixes :synopsis: File containing all standard fixes diff --git a/docs/api_ref/flow.rst b/docs/api_ref/flow.rst index a3f16dd..adfb422 100644 --- a/docs/api_ref/flow.rst +++ b/docs/api_ref/flow.rst @@ -1,5 +1,6 @@ +***************************** :mod:`flow` --- Flow Entities ------------------------------ +*****************************

.. automodule:: flow :synopsis: Objects representing Flow entities, like boards, topics, and posts diff --git a/docs/api_ref/i18n.rst b/docs/api_ref/i18n.rst index d717537..9b41287 100644 --- a/docs/api_ref/i18n.rst +++ b/docs/api_ref/i18n.rst @@ -1,11 +1,6 @@ +**************************** :mod:`i18n` --- i18n Support ----------------------------- +****************************

.. automodule:: i18n - :synopsis: Various i18n functions - -:mod:`plural` --- i18n Plural rules ------------------------------------ - -.. automodule:: plural - :synopsis: Module containing plural rules of various languages \ No newline at end of file + :synopsis: Various i18n functions \ No newline at end of file diff --git a/docs/api_ref/i18n_plural.rst b/docs/api_ref/i18n_plural.rst new file mode 100644 index 0000000..61d7844 --- /dev/null +++ b/docs/api_ref/i18n_plural.rst @@ -0,0 +1,6 @@ +*********************************** +:mod:`plural` --- i18n Plural rules +*********************************** + +.. automodule:: plural + :synopsis: Module containing plural rules of various languages \ No newline at end of file diff --git a/docs/api_ref/index.rst b/docs/api_ref/index.rst index bb402e6..5db1b21 100644 --- a/docs/api_ref/index.rst +++ b/docs/api_ref/index.rst @@ -1,8 +1,10 @@ +############# API reference -------------- +#############

+**************************** High-level request structure -============================ +****************************

User code mainly interacts with :class:`pywikibot.Page` objects, which represent pages on a specific wiki. These objects get their properties by calling functions @@ -13,8 +15,9 @@ functions provided by :mod:`data.api`. This layer then uses :func:`comms.http.request` to do the actual HTTP request.

+***************** Table of contents -================= +*****************

.. toctree:: :glob: diff --git a/docs/api_ref/iw_interwiki_graph.rst b/docs/api_ref/iw_interwiki_graph.rst index 4682f47..a918d89 100644 --- a/docs/api_ref/iw_interwiki_graph.rst +++ b/docs/api_ref/iw_interwiki_graph.rst @@ -1,5 +1,6 @@ +********************************************************** :mod:`interwiki_graph` --- Graphviz Drawing for Interwiki ----------------------------------------------------------- +**********************************************************

.. automodule:: interwiki_graph :synopsis: Module with the Graphviz drawing calls diff --git a/docs/api_ref/iw_titletranslate.rst b/docs/api_ref/iw_titletranslate.rst index b7faab7..1f9880a 100644 --- a/docs/api_ref/iw_titletranslate.rst +++ b/docs/api_ref/iw_titletranslate.rst @@ -1,5 +1,6 @@ +**************************************************** :mod:`titletranslate` --- Interwiki Title Translator ----------------------------------------------------- +****************************************************

.. automodule:: titletranslate :synopsis: Title translate module diff --git a/docs/api_ref/logentries.rst b/docs/api_ref/logentries.rst index 279f91b..e45b3f9 100644 --- a/docs/api_ref/logentries.rst +++ b/docs/api_ref/logentries.rst @@ -1,5 +1,6 @@ +************************ :mod:`logentries` module ------------------------- +************************

.. automodule:: logentries :synopsis: Objects representing Mediawiki log entries diff --git a/docs/api_ref/logging.rst b/docs/api_ref/logging.rst index ee96efd..842c542 100644 --- a/docs/api_ref/logging.rst +++ b/docs/api_ref/logging.rst @@ -1,8 +1,9 @@ .. module:: logging :synopsis: User output/logging functions

+************************************ :mod:`logging` --- Logging Functions ------------------------------------- +************************************

.. automodule:: pywikibot.logging :member-order: bysource diff --git a/docs/api_ref/login.rst b/docs/api_ref/login.rst index d0150ed..c5d12cf 100644 --- a/docs/api_ref/login.rst +++ b/docs/api_ref/login.rst @@ -1,5 +1,6 @@ +******************* :mod:`login` module -------------------- +*******************

.. automodule:: login :synopsis: Library to log the bot in to a wiki account diff --git a/docs/api_ref/proofreadpage.rst b/docs/api_ref/proofreadpage.rst index e477ea5..341fa41 100644 --- a/docs/api_ref/proofreadpage.rst +++ b/docs/api_ref/proofreadpage.rst @@ -1,5 +1,6 @@ +************************************************ :mod:`proofreadpage` --- ProofreadPage Extension ------------------------------------------------- +************************************************

.. automodule:: proofreadpage :synopsis: Objects used with ProofreadPage Extension diff --git a/docs/api_ref/pywikibot.comms.rst b/docs/api_ref/pywikibot.comms.rst index 566c41f..e471e08 100644 --- a/docs/api_ref/pywikibot.comms.rst +++ b/docs/api_ref/pywikibot.comms.rst @@ -1,18 +1,19 @@ +************************************ :mod:`comms` --- Communication layer -==================================== +************************************

.. automodule:: comms :synopsis: Communication layer

:mod:`comms.eventstreams` --- Server-Sent Events Client -------------------------------------------------------- +=======================================================

.. automodule:: comms.eventstreams :synopsis: Server-Sent Events client

:mod:`comms.http` --- HTTP access interface -------------------------------------------- +===========================================

.. automodule:: comms.http :synopsis: Basic HTTP access interface diff --git a/docs/api_ref/pywikibot.config.rst b/docs/api_ref/pywikibot.config.rst index ca1fdd8..fae255d 100644 --- a/docs/api_ref/pywikibot.config.rst +++ b/docs/api_ref/pywikibot.config.rst @@ -1,18 +1,19 @@ +*************************************** :mod:`config` --- Pywikibot Config File ---------------------------------------- +***************************************

API reference -^^^^^^^^^^^^^ +=============

.. automodule:: config :synopsis: Module to define and load pywikibot configuration default and user preferences

Option setting -^^^^^^^^^^^^^^ +==============

Account Settings -++++++++++++++++ +----------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# ACCOUNT SETTINGS @@ -20,105 +21,105 @@

User Interface Settings -+++++++++++++++++++++++ +-----------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# USER INTERFACE SETTINGS :end-before: # #############

External Editor Settings -++++++++++++++++++++++++ +------------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# EXTERNAL EDITOR SETTINGS :end-before: # #############

Logfile Settings -++++++++++++++++ +----------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# LOGFILE SETTINGS :end-before: # #############

External Script Path Settings -+++++++++++++++++++++++++++++ +-----------------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# EXTERNAL SCRIPT PATH SETTINGS :end-before: # #############

External Families Settings -++++++++++++++++++++++++++ +--------------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# EXTERNAL FAMILIES SETTINGS :end-before: # #############

Interwiki Settings -++++++++++++++++++ +------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# INTERWIKI SETTINGS :end-before: # #############

Solve Disambiguations Settings -++++++++++++++++++++++++++++++ +------------------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# SOLVE_DISAMBIGUATION SETTINGS :end-before: # #############

Image Related Settings -++++++++++++++++++++++ +----------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# IMAGE RELATED SETTINGS :end-before: # #############

Settings to Avoid Server Overload -+++++++++++++++++++++++++++++++++ +---------------------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# SETTINGS TO AVOID SERVER OVERLOAD :end-before: # #############

Weblink Checker Settings -++++++++++++++++++++++++ +------------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# WEBLINK CHECKER SETTINGS :end-before: # #############

Database Settings -+++++++++++++++++ +-----------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# DATABASE SETTINGS :end-before: # #############

Http Settings -+++++++++++++ +-------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# HTTP SETTINGS :end-before: # #############

Cosmetic Changes Settings -+++++++++++++++++++++++++ +-------------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# COSMETIC CHANGES SETTINGS :end-before: # #############

Replication Bot Settings -++++++++++++++++++++++++ +------------------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# REPLICATION BOT SETTINGS :end-before: # #############

Further Settings -++++++++++++++++ +----------------

.. literalinclude:: ../../pywikibot/config.py :start-at: # ############# FURTHER SETTINGS diff --git a/docs/api_ref/pywikibot.data.rst b/docs/api_ref/pywikibot.data.rst index 1bfc4bb..cd4f8c3 100644 --- a/docs/api_ref/pywikibot.data.rst +++ b/docs/api_ref/pywikibot.data.rst @@ -1,35 +1,36 @@ +***************************** :mod:`data` --- Data Exchange -============================= +*****************************

.. automodule:: data :synopsis: Data Exchange

:mod:`data.api` --- MediaWiki API Requests ------------------------------------------- +==========================================

.. automodule:: data.api :synopsis: Module providing several layers of data access to the wiki

:mod:`data.memento` --- Memento Requests ----------------------------------------- +========================================

.. automodule:: data.memento :synopsis: Fix ups for memento-client package version 0.6.1

:mod:`data.mysql` --- Mysql Requests ------------------------------------- +====================================

.. automodule:: data.mysql :synopsis: Miscellaneous helper functions for mysql queries

:mod:`data.sparql` --- SPARQL requests --------------------------------------- +======================================

.. automodule:: data.sparql :synopsis: SPARQL Query interface

:mod:`data.wikistats` --- WikiStats requests --------------------------------------------- +============================================

.. automodule:: data.wikistats :synopsis: Objects representing WikiStats API diff --git a/docs/api_ref/pywikibot.families.rst b/docs/api_ref/pywikibot.families.rst index a9f69b1..183ea6d 100644 --- a/docs/api_ref/pywikibot.families.rst +++ b/docs/api_ref/pywikibot.families.rst @@ -1,161 +1,162 @@ +*************************************** :mod:`families` --- Family Config Files -======================================= +***************************************

.. automodule:: families :synopsis: Families package

:mod:`families.commons_family` --- Commons -------------------------------------------- +===========================================

.. automodule:: families.commons_family :synopsis: Family module for Wikimedia Commons

:mod:`families.foundation_family` --- Foundation Wiki ------------------------------------------------------- +======================================================

.. automodule:: families.foundation_family :synopsis: Family module for Foundation Wiki

:mod:`families.i18n_family` --- Translate Wiki ------------------------------------------------ +===============================================

.. automodule:: families.i18n_family :synopsis: Family module for Translate Wiki

:mod:`families.incubator_family` --- Incubator ------------------------------------------------ +===============================================

.. automodule:: families.incubator_family :synopsis: Family module for Incubator Wiki

:mod:`families.lingualibre_family` --- Lingua Libre ----------------------------------------------------- +====================================================

.. automodule:: families.lingualibre_family :synopsis: Family module for Lingua Libre

:mod:`families.mediawiki_family` --- MediaWiki ------------------------------------------------ +===============================================

.. automodule:: families.mediawiki_family :synopsis: Family module for MediaWiki Wiki

:mod:`families.meta_family` --- Meta -------------------------------------- +=====================================

.. automodule:: families.meta_family :synopsis: Family module for Meta Wiki

:mod:`families.osm_family` --- OpenStreetMap ---------------------------------------------- +=============================================

.. automodule:: families.osm_family :synopsis: Family module for OpenStreetMap Wiki

:mod:`families.outreach_family` --- Outreach ---------------------------------------------- +=============================================

.. automodule:: families.outreach_family :synopsis: Family module for Wikimedia Outreach Wiki

:mod:`families.species_family` --- Species -------------------------------------------- +===========================================

.. automodule:: families.species_family :synopsis: Family module for Wikimedia Species Wiki

:mod:`families.vikidia_family` --- Vikidia -------------------------------------------- +===========================================

.. automodule:: families.vikidia_family :synopsis: Family module for Vikidia Wiki

:mod:`families.wikibooks_family` --- Wikibooks ------------------------------------------------ +===============================================

.. automodule:: families.wikibooks_family :synopsis: Family module for Wikibooks

:mod:`families.wikidata_family` --- Wikidata ---------------------------------------------- +=============================================

.. automodule:: families.wikidata_family :synopsis: Family module for Wikidata

:mod:`families.wikihow_family` --- Wikihow -------------------------------------------- +===========================================

.. automodule:: families.wikihow_family :synopsis: Family module for Wikihow Wiki

:mod:`families.wikimania_family` --- Wikimania ------------------------------------------------ +===============================================

.. automodule:: families.wikimania_family :synopsis: Family module for Wikimania Wikis

:mod:`families.wikimediachapter_family` --- Wikimedia Chapter --------------------------------------------------------------- +==============================================================

.. automodule:: families.wikimediachapter_family :synopsis: Family module for Wikimedia chapter, thematic organisation and WUG wikis

:mod:`families.wikinews_family` --- Wikinews ---------------------------------------------- +=============================================

.. automodule:: families.wikinews_family :synopsis: Family module for Wikinews

:mod:`families.wikipedia_family` --- Wikipedia ------------------------------------------------ +===============================================

.. automodule:: families.wikipedia_family :synopsis: Family module for Wikipedia

:mod:`families.wikiquote_family` --- Wikiquote ------------------------------------------------ +===============================================

.. automodule:: families.wikiquote_family :synopsis: Family module for Wikiquote

:mod:`families.wikisource_family` --- Wikisource -------------------------------------------------- +=================================================

.. automodule:: families.wikisource_family :synopsis: Family module for Wikisource

:mod:`families.wikisopore_family` --- Wikispore ------------------------------------------------- +================================================

.. automodule:: families.wikispore_family :synopsis: Family module for Wikispore

:mod:`families.wikitech_family` --- Wikitech ---------------------------------------------- +=============================================

.. automodule:: families.wikitech_family :synopsis: Family module for Wikitech

:mod:`families.wikiversity_family` --- Wikiversity ---------------------------------------------------- +===================================================

.. automodule:: families.wikiversity_family :synopsis: Family module for Wikiversity

:mod:`families.wikivoyage_family`--- Wikivoyage ------------------------------------------------- +================================================

.. automodule:: families.wikivoyage_family :synopsis: Family module for Wikivoyage

:mod:`families.wiktionary_family` --- Wiktionary -------------------------------------------------- +=================================================

.. automodule:: families.wiktionary_family :synopsis: Family module for Wiktionary

:mod:`families.wowwiki_family` --- Fandom WOW ----------------------------------------------- +==============================================

.. automodule:: families.wowwiki_family :synopsis: Family module for Fandom WOW Wiki diff --git a/docs/api_ref/pywikibot.page.rst b/docs/api_ref/pywikibot.page.rst index 2b8a308..f3712ad 100644 --- a/docs/api_ref/pywikibot.page.rst +++ b/docs/api_ref/pywikibot.page.rst @@ -1,33 +1,31 @@ +******************************* :mod:`page` --- MediaWiki Pages -=============================== +*******************************

.. automodule:: page :synopsis: Interface of various types of MediaWiki pages

-Page Submodules ---------------- - :mod:`page._collections` Wikibase Entity Structures ----------------------------------------------------- +====================================================

.. automodule:: pywikibot.page._collections :synopsis: Structures holding data for Wikibase entities

:mod:`page._decorators` --- Page Decorators --------------------------------------------- +============================================

.. automodule:: page._decorators :synopsis: Decorators for Page objects :private-members:

:mod:`page._revision` --- Page Revision ----------------------------------------- +========================================

.. automodule:: page._revision :synopsis: Object representing page revision

:mod:`page._toolforge` module ---------------------------------- +==============================

.. automodule:: page._toolforge - :synopsis: Object representing interface to toolforge tools \ No newline at end of file + :synopsis: Object representing interface to toolforge tools diff --git a/docs/api_ref/pywikibot.pagegenerators.rst b/docs/api_ref/pywikibot.pagegenerators.rst index 3a8fcd5..de9269d 100644 --- a/docs/api_ref/pywikibot.pagegenerators.rst +++ b/docs/api_ref/pywikibot.pagegenerators.rst @@ -1,23 +1,24 @@ +***************************************** :mod:`pagegenerators` --- Page Generators -========================================= +*****************************************

.. automodule:: pagegenerators :synopsis: This module offers a wide variety of page generators

:mod:`pagegenerators._factory` --- Pagegenerators Options Handler ------------------------------------------------------------------- +==================================================================

.. automodule:: pagegenerators._factory :synopsis: GeneratorFactory module wich handles pagegenerators options

:mod:`pagegenerators._filters` --- Filter Funtions ---------------------------------------------------- +===================================================

.. automodule:: pagegenerators._filters :synopsis: Page filter generators provided by the pagegenerators module

:mod:`pagegenerators._generators` --- Generator Functions ----------------------------------------------------------- +==========================================================

.. automodule:: pagegenerators._generators :synopsis: Page filter generators provided by the pagegenerators module diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index 3ae62f5..3e87817 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -1,4 +1,5 @@ +*********************************************** :mod:`pywikibot` --- Base Classes and Functions -=============================================== +***********************************************

.. automodule:: pywikibot diff --git a/docs/api_ref/pywikibot.site.rst b/docs/api_ref/pywikibot.site.rst index 046348e..ff43afc 100644 --- a/docs/api_ref/pywikibot.site.rst +++ b/docs/api_ref/pywikibot.site.rst @@ -1,5 +1,6 @@ +******************************* :mod:`site` --- MediaWiki sites -=============================== +*******************************

.. py:module:: site :synopsis: Library module representing MediaWiki sites (wikis) @@ -9,7 +10,7 @@ :noindex:

:mod:`BaseSite<pywikibot.site._basesite>` --- Base Class for Sites ------------------------------------------------------------------- +==================================================================

.. py:module:: site._basesite :synopsis: Objects with site methods independent of the communication interface @@ -20,7 +21,7 @@ :synopsis: Objects representing API interface to MediaWiki site

:mod:`APISite<pywikibot.site._apisite>` --- API Interface for Sites --------------------------------------------------------------------- +====================================================================

.. automodule:: pywikibot.site._apisite

@@ -31,7 +32,7 @@ :synopsis: Objects representing API generators to MediaWiki site

:mod:`DataSite<pywikibot.site._datasite>` --- API Interface for Wikibase -------------------------------------------------------------------------- +=========================================================================

.. py:module:: site._datasite :synopsis: Objects representing API interface to Wikibase site @@ -39,7 +40,7 @@ .. automodule:: pywikibot.site._datasite

:mod:`Obsolete Sites<pywikibot.site._obsoletesites>` --- Outdated Sites ------------------------------------------------------------------------ +=======================================================================

.. py:module:: site._obsoletesites :synopsis: Objects representing obsolete MediaWiki sites @@ -47,7 +48,7 @@ .. automodule:: pywikibot.site._obsoletesites

:mod:`Siteinfo<pywikibot.site._siteinfo>` --- Site Info Container ------------------------------------------------------------------ +=================================================================

.. py:module:: site._siteinfo :synopsis: Objects representing site info data contents @@ -55,7 +56,7 @@ .. automodule:: pywikibot.site._siteinfo

:mod:`Namespace<pywikibot.site._namespace>` --- Namespace Object ----------------------------------------------------------------- +================================================================

.. py:module:: site._namespace :synopsis: Objects representing Namespaces of MediaWiki site @@ -63,7 +64,7 @@ .. automodule:: pywikibot.site._namespace

:mod:`TokenWallet<pywikibot.site._tokenwallet>` --- Token Wallet ----------------------------------------------------------------- +================================================================

.. py:module:: site._tokenwallet :synopsis: Objects representing api tokens @@ -71,7 +72,7 @@ .. automodule:: pywikibot.site._tokenwallet

:mod:`Uploader<pywikibot.site._upload>` --- Uploader Interface --------------------------------------------------------------- +==============================================================

.. py:module:: site._upload :synopsis: Objects representing API upload to MediaWiki site diff --git a/docs/api_ref/pywikibot.specialbots.rst b/docs/api_ref/pywikibot.specialbots.rst index 7a91759..e9b2760 100644 --- a/docs/api_ref/pywikibot.specialbots.rst +++ b/docs/api_ref/pywikibot.specialbots.rst @@ -1,5 +1,6 @@ -:mod:`specialbots` --- Special Reusable Bots -============================================ +******************************************** +:mod:`specialbots` --- Special Reusable Bots +********************************************

.. automodule:: specialbots - :synopsis: Module containing special bots reusable by scripts \ No newline at end of file + :synopsis: Module containing special bots reusable by scripts diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst index 28289da..c126021 100644 --- a/docs/api_ref/pywikibot.tools.rst +++ b/docs/api_ref/pywikibot.tools.rst @@ -1,53 +1,54 @@ +*********************************************** :mod:`tools` --- Miscellaneous Helper Functions -=============================================== +***********************************************

.. automodule:: tools :synopsis: Miscellaneous helper functions (not wiki-dependent)

:mod:`tools.chars` --- Character Based Helper Functions -------------------------------------------------------- +=======================================================

.. automodule:: tools.chars :synopsis: Character based helper functions (not wiki-dependent)

:mod:`tools.collections` --- Container datatypes ------------------------------------------------- +================================================

.. automodule:: tools.collections :synopsis: Collections datatypes

:mod:`tools.deprecate` --- Deprecating Decorators and Classes -------------------------------------------------------------- +=============================================================

.. automodule:: tools._deprecate :synopsis: Module providing deprecation decorators

:mod:`tools.djvu` --- DJVU files wrapper ----------------------------------------- +========================================

.. automodule:: tools.djvu :synopsis: Wrapper around djvulibre to access djvu files properties and content

:mod:`tools.formatter` --- Formatting Related Functions and Classes -------------------------------------------------------------------- +===================================================================

.. automodule:: tools.formatter :synopsis: Module containing various formatting related utilities

:mod:`tools.itertools` --- Iterators for Efficient Looping ----------------------------------------------------------- +==========================================================

.. automodule:: tools.itertools :synopsis: Iterator functions

:mod:`tools.threading` --- Thread-based Classes ------------------------------------------------ +===============================================

.. automodule:: tools.threading :synopsis: Threading classes

:mod:`tools._logging` --- logging.Formatter Subclass ------------------------------------------------------ +=====================================================

.. automodule:: tools._logging :synopsis: Logging tools diff --git a/docs/api_ref/pywikibot.userinterfaces.rst b/docs/api_ref/pywikibot.userinterfaces.rst index 576e61e..10019db 100644 --- a/docs/api_ref/pywikibot.userinterfaces.rst +++ b/docs/api_ref/pywikibot.userinterfaces.rst @@ -1,53 +1,54 @@ +***************************************** :mod:`userinterfaces` --- User interfaces -========================================= +*****************************************

.. automodule:: userinterfaces :synopsis: User interfaces module

:mod:`_interface_base` --- Abstract User Interface ----------------------------------------------------- +====================================================

.. automodule:: userinterfaces._interface_base :synopsis: Abstract base user interface module

:mod:`terminal_interface` module --- Terminal User Interface -------------------------------------------------------------- +=============================================================

.. automodule:: userinterfaces.terminal_interface :synopsis: Platform independent terminal interface module

:mod:`terminal_interface_base` --- Base Terminal Interface -------------------------------------------------------------- +=============================================================

.. automodule:: userinterfaces.terminal_interface_base :synopsis: Base for terminal user interfaces

:mod:`terminal_interface_unix` --- Unix Terminal Interface ------------------------------------------------------------- +============================================================

.. automodule:: userinterfaces.terminal_interface_unix :synopsis: User interface for Unix terminals

:mod:`terminal_interface_win32` ---- Windows Terminal Interface ------------------------------------------------------------------ +=================================================================

.. automodule:: userinterfaces.terminal_interface_win32 :synopsis: User interface for Win32 terminals

:mod:`buffer_interface` --- Buffer Interface ---------------------------------------------- +=============================================

.. automodule:: userinterfaces.buffer_interface :synopsis: Non-interactive interface that stores output

:mod:`gui` --- Graphical User Interface ---------------------------------------- +=======================================

.. automodule:: userinterfaces.gui :synopsis: A window with a textfield where the user can edit

:mod:`transliteration` --- Transliteration ------------------------------------------- +==========================================

.. automodule:: userinterfaces.transliteration :synopsis: Module to transliterate text diff --git a/docs/api_ref/reader.rst b/docs/api_ref/reader.rst index 83e2d16..d90abce 100644 --- a/docs/api_ref/reader.rst +++ b/docs/api_ref/reader.rst @@ -1,5 +1,6 @@ +******************************* :mod:`xmlreader` --- XML Reader -------------------------------- +*******************************

.. automodule:: xmlreader :synopsis: XML reading module diff --git a/docs/api_ref/site_detect.rst b/docs/api_ref/site_detect.rst index bd08507..3f6ab3e 100644 --- a/docs/api_ref/site_detect.rst +++ b/docs/api_ref/site_detect.rst @@ -1,5 +1,6 @@ +************************************************************* :mod:`site_detect` --- Classes for Detecting MediaWiki Sites -------------------------------------------------------------- +*************************************************************

.. automodule:: site_detect :synopsis: Classes for detecting a MediaWiki site diff --git a/docs/api_ref/textlib.rst b/docs/api_ref/textlib.rst index d1708ac..6f33505 100644 --- a/docs/api_ref/textlib.rst +++ b/docs/api_ref/textlib.rst @@ -1,5 +1,6 @@ +************************************ :mod:`textlib` --- Changing Wikitext ------------------------------------- +************************************

.. automodule:: textlib :synopsis: Functions for manipulating wiki-text diff --git a/docs/api_ref/throttle.rst b/docs/api_ref/throttle.rst index 71eda40..e599c3b 100644 --- a/docs/api_ref/throttle.rst +++ b/docs/api_ref/throttle.rst @@ -1,5 +1,6 @@ +************************************** :mod:`throttle` --- Slow Down Wiki I/O --------------------------------------- +**************************************

.. automodule:: throttle :synopsis: Mechanics to slow down wiki read and/or write rate diff --git a/docs/api_ref/version.rst b/docs/api_ref/version.rst index 58e7b9d..d5c9340 100644 --- a/docs/api_ref/version.rst +++ b/docs/api_ref/version.rst @@ -1,5 +1,6 @@ +********************************************** :mod:`version` --- Determine Pywikibot Version ----------------------------------------------- +**********************************************

.. automodule:: version :synopsis: Module to determine the pywikibot version (tag, revision and date) diff --git a/docs/api_ref/x_backports.rst b/docs/api_ref/x_backports.rst index ba67f44..d6540f3 100644 --- a/docs/api_ref/x_backports.rst +++ b/docs/api_ref/x_backports.rst @@ -1,5 +1,6 @@ +************************************* :mod:`backports` --- Python Backports -------------------------------------- +*************************************

.. automodule:: backports :synopsis: This module contains backports to support older Python versions diff --git a/docs/credits.rst b/docs/credits.rst index 9a9aeb0..142c22c 100644 --- a/docs/credits.rst +++ b/docs/credits.rst @@ -1,4 +1,5 @@ +******* Credits -======= +*******

.. include:: ../AUTHORS.rst diff --git a/docs/faq.rst b/docs/faq.rst index f707136..2e2f052 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,5 +1,6 @@ -Frequent asked questions -======================== +************************** +Frequently asked questions +**************************

**How to speed up Pywikibot?** 1. The first time you are using Pywikibot for multiple Wikimedia sites you diff --git a/docs/getting_help.rst b/docs/getting_help.rst index 52c3f16..b1ac1f7 100644 --- a/docs/getting_help.rst +++ b/docs/getting_help.rst @@ -1,5 +1,6 @@ +************ Getting help ------------- +************

.. note:: For information on how to connect with Pywikibot developers and users, see :manpage:`Communication`. diff --git a/docs/global_options.rst b/docs/global_options.rst index 59f082d..8fec0ef 100644 --- a/docs/global_options.rst +++ b/docs/global_options.rst @@ -4,6 +4,6 @@ Global arguments available for all bots:

.. literalinclude:: ../pywikibot/bot.py - :language: console + :language: text :start-after: (Global arguments available for all bots) :end-before: """ diff --git a/docs/glossary.rst b/docs/glossary.rst index bfc7a3b..f88a02e 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -1,5 +1,6 @@ +******** Glossary -======== +********

.. if you add new entries, keep the alphabetical sorting!

@@ -75,4 +76,4 @@ The Python Package Index (PyPI), a repository of software for the Python programming language. Pywikibot framework (without scripts) is `published monthly at PyPI - https://pypi.org/project/pywikibot/`_. \ No newline at end of file + https://pypi.org/project/pywikibot/`_. diff --git a/docs/index.rst b/docs/index.rst index 4dd75b9..a7b1802 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,6 @@ -Pywikibot Documentation -======================= +####################### +Pywikibot documentation +#######################

Welcome! This is the documentation for Pywikibot |release|.

@@ -29,15 +30,16 @@

.. seealso:: `Pywikibot Manual`_ at https://www.mediawiki.org

+************************** +Framework modules overview +**************************

-Framework Modules Overview --------------------------- .. image:: framework.png :alt: Framework modules dependency network

- +******** Contents --------- +********

.. toctree:: :maxdepth: 1 diff --git a/docs/installation.rst b/docs/installation.rst index b39bd99..bab9e27 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,6 +1,7 @@ :orphan:

+************ Installation -============ +************

Moved to :doc:`introduction`. diff --git a/docs/licenses.rst b/docs/licenses.rst index 86c44e8..7196e1f 100644 --- a/docs/licenses.rst +++ b/docs/licenses.rst @@ -1,7 +1,8 @@ :tocdepth: 1

+******** Licenses -======== +********

**The framework itself and this documentation** are available under the :ref:`MIT license`; translations by translators and manual pages on @@ -14,7 +15,7 @@

MIT License ------------ +=========== **The framework is available under the MIT license.**

.. include:: ../LICENSE diff --git a/docs/mwapi.rst b/docs/mwapi.rst index fed2829..7072057 100644 --- a/docs/mwapi.rst +++ b/docs/mwapi.rst @@ -3,8 +3,9 @@

<br />

+***************************** MediaWiki API cross reference -============================= +*****************************

See the table below for a cross reference between MediaWiki's API and Pywikibot's API.

diff --git a/docs/recipes.rst b/docs/recipes.rst index c0c3983..bba2fdd 100644 --- a/docs/recipes.rst +++ b/docs/recipes.rst @@ -1,8 +1,9 @@ +******* Recipes -======= +*******

How to modify a page --------------------- +====================

...

...

page = pywikibot.Page(pywikibot.Site(), 'Sample page') new_content = page.text.replace('this', 'that')

@@ -11,7 +12,7 @@ See :doc:`library_usage` for more advanced samples.

How to get links from summary section of page ---------------------------------------------- +=============================================

...

...

import pywikibot from pwikibot import textlib

diff --git a/docs/scripts/administrative.rst b/docs/scripts/administrative.rst index 5d97c08..bc7e5ef 100644 --- a/docs/scripts/administrative.rst +++ b/docs/scripts/administrative.rst @@ -1,43 +1,44 @@ +********************** Administrative scripts -====================== +**********************

-blockpageschecker script description ------------------------------------- +blockpageschecker script +========================

.. automodule:: scripts.blockpageschecker :no-members: :noindex:

-delete script description -------------------------- +delete script +=============

.. automodule:: scripts.delete :no-members: :noindex:

-patrol script description -------------------------- +patrol script +=============

.. automodule:: scripts.patrol :no-members: :noindex:

-protect script description --------------------------- +protect script +==============

.. automodule:: scripts.protect :no-members: :noindex:

-revertbot script description ----------------------------- +revertbot script +================

.. automodule:: scripts.revertbot :no-members: :noindex:

-speedy_delete script description ---------------------------------- +speedy_delete script +=====================

.. automodule:: scripts.speedy_delete :no-members: diff --git a/docs/scripts/archive.rst b/docs/scripts/archive.rst index 107e990..dc11cc8 100644 --- a/docs/scripts/archive.rst +++ b/docs/scripts/archive.rst @@ -1,5 +1,6 @@ +********************* Outdated core scripts -===================== +*********************

This list contains outdated scripts from :term:`core` banch which aren't supported any longer. They are either archived or deleted. @@ -13,7 +14,7 @@

capitalize_redirects script ----------------------------- +============================

**Bot to create capitalized redirects**

@@ -22,12 +23,12 @@

casechecker script ------------------- +==================

**Bot to find all pages on the wiki with mixed latin and cyrilic alphabets**

catall script -------------- +=============

**This script shows the categories on each page and lets you change them**

@@ -40,7 +41,7 @@

commons_link script --------------------- +====================

**Include Commons template in home wiki**

@@ -51,7 +52,7 @@ redirect, this also functions.

create_categories script ------------------------- +========================

**Program to batch create categories**

@@ -60,25 +61,25 @@

disambredirs script -------------------- +===================

**User assisted updating redirect links on disambiguation pages**

editarticle script ------------------- +==================

**Edit a Wikipedia article with your favourite editor**

flickrripper script -------------------- +===================

**A tool to transfer flickr photos to Wikimedia Commons**

followlive ----------- +==========

**Periodically grab list of new articles and analyze to blank or flag them**

@@ -87,7 +88,7 @@

freebasemappingupload script ----------------------------- +============================

**Script to upload the mappings of Freebase to Wikidata**

@@ -98,7 +99,7 @@

imagecopy script ----------------- +================

**Script to copy files from a local Wikimedia wiki to Wikimedia Commons**

@@ -113,7 +114,7 @@

imagecopy_self script ----------------------- +======================

**Script to copy self published files from English Wikipedia to Commons**

@@ -125,7 +126,7 @@

imageharvest script -------------------- +===================

**Bot for getting multiple images from an external site**

@@ -141,7 +142,7 @@

imagerecat script ------------------ +=================

**Program to re-categorize images at commons**

@@ -150,7 +151,7 @@

imageuncat script ------------------ +=================

**Program to add uncat template to images without categories at commons**

@@ -160,7 +161,7 @@ the site commons should be given and not a Wikipedia or similar.

isbn script ------------ +===========

**This script reports and fixes invalid ISBN numbers**

@@ -169,13 +170,13 @@

lonelypages script ------------------- +==================

**This is a script written to add the template "orphan" to pages**

makecat script --------------- +==============

**Bot to add new or existing categories to pages**

@@ -186,13 +187,13 @@

match_images script --------------------- +====================

**Program to match two images based on histograms**

ndashredir script ------------------ +=================

**A script to create hyphenated redirects for n or m dash pages**

@@ -206,31 +207,31 @@

piper script ------------- +============

**This bot uses external filtering programs for munging text**

selflink script ---------------- +===============

**This bot searches for selflinks and allows removing them**

spamremove script ------------------ +=================

**Script to remove links that are being or have been spammed**

standardize_interwiki script ------------------------------ +=============================

**Loop over all pages in the home wiki, standardizing the interwiki links**

states_redirect script ------------------------ +=======================

**Create country sub-division redirect pages**

@@ -239,7 +240,7 @@

surnames_redirects script --------------------------- +==========================

**Bot to create redirects based on name order**

@@ -248,19 +249,19 @@

table2wiki script ------------------ +=================

**Nifty script to convert HTML-tables to MediaWiki's own syntax**

unlink script -------------- +=============

**This bot unlinks a page on every page that links to it**

wikisourcetext script ---------------------- +=====================

**This bot applies to Wikisource sites to upload text**

diff --git a/docs/scripts/auxiliary.rst b/docs/scripts/auxiliary.rst index afff626..e4874ca 100644 --- a/docs/scripts/auxiliary.rst +++ b/docs/scripts/auxiliary.rst @@ -1,22 +1,23 @@ +***************** Auxiliary scripts -================= +*****************

-clean_sandbox script description ---------------------------------- +clean_sandbox script +=====================

.. automodule:: scripts.clean_sandbox :no-members: :noindex:

-cosmetic_changes script description ------------------------------------- +cosmetic_changes script +========================

.. automodule:: scripts.cosmetic_changes :no-members: :noindex:

-transferbot script description ------------------------------- +transferbot script +==================

.. automodule:: scripts.transferbot :no-members: diff --git a/docs/scripts/categories.rst b/docs/scripts/categories.rst index 3920f6a..a282357 100644 --- a/docs/scripts/categories.rst +++ b/docs/scripts/categories.rst @@ -1,15 +1,16 @@ +****************** Categories scripts -================== +******************

-category_redirect script description -------------------------------------- +category_redirect script +=========================

.. automodule:: scripts.category_redirect :no-members: :noindex:

-commonscat script description ------------------------------ +commonscat script +=================

.. automodule:: scripts.commonscat :no-members: diff --git a/docs/scripts/general.rst b/docs/scripts/general.rst index 144b194..fda9d15 100644 --- a/docs/scripts/general.rst +++ b/docs/scripts/general.rst @@ -1,22 +1,23 @@ +***************************** General pages changes scripts -============================= +*****************************

-archivebot script description description ------------------------------------------ +archivebot script +=================

.. automodule:: scripts.archivebot :no-members: :noindex:

-movepages script description description ----------------------------------------- +movepages script +================

.. automodule:: scripts.movepages :no-members: :noindex:

-pagefromfile script description description -------------------------------------------- +pagefromfile script +===================

.. automodule:: scripts.pagefromfile :no-members: diff --git a/docs/scripts/global.rst b/docs/scripts/global.rst index 679f67d..757def8 100644 --- a/docs/scripts/global.rst +++ b/docs/scripts/global.rst @@ -1,8 +1,9 @@ +****************** Global bot scripts -================== +******************

-interwiki script description ----------------------------- +interwiki script +================

Creates or modifies Interlanguage links between projects.

@@ -10,8 +11,8 @@ :no-members: :noindex:

-redirect script description ---------------------------- +redirect script +===============

.. automodule:: scripts.redirect :no-members: diff --git a/docs/scripts/images.rst b/docs/scripts/images.rst index 6340b25..0c1e564 100644 --- a/docs/scripts/images.rst +++ b/docs/scripts/images.rst @@ -1,50 +1,51 @@ +************** Images scripts -============== +**************

-checkimages script description ------------------------------- +checkimages script +==================

.. automodule:: scripts.checkimages :no-members: :noindex:

-commons_information script description ---------------------------------------- +commons_information script +===========================

.. automodule:: scripts.commons_information :no-members: :noindex:

-data_ingestion script description ----------------------------------- +data_ingestion script +======================

.. automodule:: scripts.data_ingestion :no-members: :noindex:

-image script description ------------------------- +image script +============

.. automodule:: scripts.image :no-members: :noindex:

-imagetransfer script description --------------------------------- +imagetransfer script +====================

.. automodule:: scripts.imagetransfer :no-members: :noindex:

-nowcommons script description ------------------------------ +nowcommons script +=================

.. automodule:: scripts.nowcommons :no-members: :noindex:

-unusedfiles script description ------------------------------- +unusedfiles script +==================

.. automodule:: scripts.unusedfiles :no-members: diff --git a/docs/scripts/index.rst b/docs/scripts/index.rst index dec2fe6..ba9751a 100644 --- a/docs/scripts/index.rst +++ b/docs/scripts/index.rst @@ -1,6 +1,6 @@ -=============== +############### Scripts package -=============== +###############

.. automodule:: scripts :no-members: @@ -10,8 +10,9 @@ :start-after: included. :end-before: More precise

+******************* Script descriptions -=================== +*******************

.. toctree:: :maxdepth: 1 diff --git a/docs/scripts/main.rst b/docs/scripts/main.rst index 50170f3..55da1ea 100644 --- a/docs/scripts/main.rst +++ b/docs/scripts/main.rst @@ -1,43 +1,44 @@ +**************** Main bot scripts -================ +****************

-add_text script description ----------------------------- +add_text script +================

.. automodule:: scripts.add_text :no-members: :noindex:

-category script description ---------------------------- +category script +===============

.. automodule:: scripts.category :no-members: :noindex:

-replace script description --------------------------- +replace script +==============

.. automodule:: scripts.replace :no-members: :noindex:

-solve_disambiguation script description ----------------------------------------- +solve_disambiguation script +============================

.. automodule:: scripts.solve_disambiguation :no-members: :noindex:

-upload script description -------------------------- +upload script +=============

.. automodule:: scripts.upload :no-members: :noindex:

-weblinkchecker script description ---------------------------------- +weblinkchecker script +=====================

.. automodule:: scripts.weblinkchecker :no-members: diff --git a/docs/scripts/maintenance.rst b/docs/scripts/maintenance.rst index cf64b30..b42c812 100644 --- a/docs/scripts/maintenance.rst +++ b/docs/scripts/maintenance.rst @@ -1,29 +1,30 @@ +*************** Utility scripts -=============== +***************

-cache script description ------------------------- +cache script +============

.. automodule:: scripts.maintenance.cache :no-members: :noindex:

-colors script description -------------------------- +colors script +=============

.. automodule:: scripts.maintenance.colors :no-members: :noindex:

-sorting_order script description ---------------------------------- +sorting_order script +=====================

.. automodule:: scripts.maintenance.sorting_order :no-members: :noindex:

-wikimedia_sites script description ------------------------------------ +wikimedia_sites script +=======================

.. automodule:: scripts.maintenance.wikimedia_sites :no-members: diff --git a/docs/scripts/nonedit.rst b/docs/scripts/nonedit.rst index a16112b..96778ce 100644 --- a/docs/scripts/nonedit.rst +++ b/docs/scripts/nonedit.rst @@ -1,15 +1,16 @@ +******************* Non editing scripts -=================== +*******************

-listpages script description ----------------------------- +listpages script +================

.. automodule:: scripts.listpages :no-members: :noindex:

-touch script description ------------------------- +touch script +============

.. automodule:: scripts.touch :no-members: diff --git a/docs/scripts/other.rst b/docs/scripts/other.rst index f2a0089..c8962ab 100644 --- a/docs/scripts/other.rst +++ b/docs/scripts/other.rst @@ -1,8 +1,9 @@ +***************** Other bot scripts -================= +*****************

-welcome script description --------------------------- +welcome script +==============

.. automodule:: scripts.welcome :no-members: diff --git a/docs/scripts/outdated.rst b/docs/scripts/outdated.rst index 49f00a0..53f6e2f 100644 --- a/docs/scripts/outdated.rst +++ b/docs/scripts/outdated.rst @@ -1,5 +1,6 @@ +*********************** Outdated compat scripts -======================= +***********************

This list contains outdated scripts from :term:`compat` banch which haven't ported to the :term:`core` branch of Pywikibot. diff --git a/docs/scripts/templates.rst b/docs/scripts/templates.rst index 5bb8f5e..b5ce11d 100644 --- a/docs/scripts/templates.rst +++ b/docs/scripts/templates.rst @@ -1,15 +1,16 @@ +**************** Template scripts -================ +****************

-template script description ---------------------------- +template script +===============

.. automodule:: scripts.template :no-members: :noindex:

-templatecount script description --------------------------------- +templatecount script +====================

.. automodule:: scripts.templatecount :no-members: diff --git a/docs/scripts/unsorted.rst b/docs/scripts/unsorted.rst index ee6fcbd..a543041 100644 --- a/docs/scripts/unsorted.rst +++ b/docs/scripts/unsorted.rst @@ -1,90 +1,91 @@ +**************** Unsorted scripts -================ +****************

-basic script description ------------------------- +basic script +============

.. automodule:: scripts.basic :no-members: :noindex:

-change_pagelang script description ------------------------------------ +change_pagelang script +=======================

.. automodule:: scripts.change_pagelang :no-members: :noindex:

-coordinate_import script description -------------------------------------- +coordinate_import script +=========================

.. automodule:: scripts.coordinate_import :no-members: :noindex:

-delinker script description ---------------------------- +delinker script +=============== .. automodule:: scripts.delinker :no-members: :noindex:

-djvutext script description ---------------------------- +djvutext script +=============== .. automodule:: scripts.djvutext :no-members: :noindex:

-download_dump script description ---------------------------------- +download_dump script +=====================

.. automodule:: scripts.download_dump :no-members: :noindex:

-fixing_redirects script description ------------------------------------- +fixing_redirects script +========================

.. automodule:: scripts.fixing_redirects :no-members: :noindex:

-misspelling script description ------------------------------- +misspelling script +==================

.. automodule:: scripts.misspelling :no-members: :noindex:

-noreferences script description -------------------------------- +noreferences script +===================

.. automodule:: scripts.noreferences :no-members: :noindex:

-parser_function_count script description ------------------------------------------- +parser_function_count script +==============================

.. automodule:: scripts.parser_function_count :no-members: :noindex:

-reflinks script description ---------------------------- +reflinks script +===============

.. automodule:: scripts.reflinks :no-members: :noindex:

-replicate_wiki script description ----------------------------------- +replicate_wiki script +=======================

.. automodule:: scripts.replicate_wiki :no-members: :noindex:

-watchlist script description ----------------------------- +watchlist script +================

.. automodule:: scripts.watchlist :no-members: diff --git a/docs/scripts/wikibase.rst b/docs/scripts/wikibase.rst index 28d3965..a3d4501 100644 --- a/docs/scripts/wikibase.rst +++ b/docs/scripts/wikibase.rst @@ -1,50 +1,51 @@ +**************** Wikibase scripts -================ +****************

-claimit script description --------------------------- +claimit script +==============

.. automodule:: scripts.claimit :no-members: :noindex:

-create_isbn_edition script description ----------------------------------------- +create_isbn_edition script +============================

.. automodule:: scripts.create_isbn_edition :no-members: :noindex:

-dataextend script description ------------------------------ +dataextend script +=================

.. automodule:: scripts.dataextend :no-members: :noindex:

-harvest_template script description ------------------------------------- +harvest_template script +========================

.. automodule:: scripts.harvest_template :no-members: :noindex:

-illustrate_wikidata script description ---------------------------------------- +illustrate_wikidata script +===========================

.. automodule:: scripts.illustrate_wikidata :no-members: :noindex:

-interwikidata script description --------------------------------- +interwikidata script +====================

.. automodule:: scripts.interwikidata :no-members: :noindex:

-newitem script description --------------------------- +newitem script +==============

.. automodule:: scripts.newitem :no-members: diff --git a/docs/scripts_ref/index.rst b/docs/scripts_ref/index.rst index 04b5165..0a582b3 100644 --- a/docs/scripts_ref/index.rst +++ b/docs/scripts_ref/index.rst @@ -1,13 +1,14 @@ +################# Scripts reference ------------------ +#################

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.i18n.rst b/docs/scripts_ref/scripts.i18n.rst index a47108e..725eb11 100644 --- a/docs/scripts_ref/scripts.i18n.rst +++ b/docs/scripts_ref/scripts.i18n.rst @@ -1,4 +1,5 @@ +******************************** Translation files - scripts.i18n -================================ +********************************

.. automodule:: scripts.i18n diff --git a/docs/scripts_ref/scripts.maintenance.rst b/docs/scripts_ref/scripts.maintenance.rst index 4f8df36..4f2d4b6 100644 --- a/docs/scripts_ref/scripts.maintenance.rst +++ b/docs/scripts_ref/scripts.maintenance.rst @@ -1,35 +1,36 @@ +******************* Maintenance scripts -=================== +*******************

This page contains documentation of the `scripts.maintenance` module:

.. automodule:: scripts.maintenance

Maintenance submodules ----------------------- +======================

scripts.maintenance.cache --------------------------------- +-------------------------

.. automodule:: scripts.maintenance.cache :ignore-module-all:

scripts.maintenance.colors ---------------------------------- +--------------------------

.. automodule:: scripts.maintenance.colors

scripts.maintenance.make_i18n_dict -------------------------------------------- +------------------------------------

.. automodule:: scripts.maintenance.make_i18n_dict

scripts.maintenance.sorting_order ------------------------------------------ +----------------------------------

.. automodule:: scripts.maintenance.sorting_order

scripts.maintenance.wikimedia_sites -------------------------------------------- +------------------------------------

.. automodule:: scripts.maintenance.wikimedia_sites diff --git a/docs/scripts_ref/scripts.rst b/docs/scripts_ref/scripts.rst index da12f0a..4009f52 100644 --- a/docs/scripts_ref/scripts.rst +++ b/docs/scripts_ref/scripts.rst @@ -1,279 +1,281 @@ +*************** Scripts package -=============== +***************

.. automodule:: scripts

add_text script ----------------- +================

.. automodule:: scripts.add_text

archivebot script ------------------ +=================

.. automodule:: scripts.archivebot

basic script ------------- +============

.. automodule:: scripts.basic

blockpageschecker script ------------------------- +========================

.. automodule:: scripts.blockpageschecker

category script ---------------- +===============

.. automodule:: scripts.category

category_redirect script -------------------------- +=========================

.. automodule:: scripts.category_redirect

change_pagelang script ------------------------ +=======================

.. automodule:: scripts.change_pagelang

checkimages script ------------------- +==================

.. automodule:: scripts.checkimages

claimit script --------------- +==============

.. automodule:: scripts.claimit

clean_sandbox script ---------------------- +=====================

.. automodule:: scripts.clean_sandbox

commons_information script ---------------------------- +===========================

.. automodule:: scripts.commons_information

commonscat script ------------------ +=================

.. automodule:: scripts.commonscat

coordinate_import script -------------------------- +=========================

.. automodule:: scripts.coordinate_import

cosmetic_changes script ------------------------- +========================

.. automodule:: scripts.cosmetic_changes

create_isbn_edition script ----------------------------- +============================

.. automodule:: scripts.create_isbn_edition

dataextend script ------------------ +=================

.. automodule:: scripts.dataextend

data_ingestion script ----------------------- +======================

.. automodule:: scripts.data_ingestion

delete script -------------- +=============

.. automodule:: scripts.delete

delinker script ---------------- +===============

.. automodule:: scripts.delinker

djvutext script ---------------- +=============== + .. automodule:: scripts.djvutext

download_dump script ---------------------- +=====================

.. automodule:: scripts.download_dump

fixing_redirects script ------------------------- +========================

.. automodule:: scripts.fixing_redirects

harvest_template script ------------------------- +========================

.. automodule:: scripts.harvest_template

illustrate_wikidata script ---------------------------- +===========================

.. automodule:: scripts.illustrate_wikidata

image script ------------- +============

.. automodule:: scripts.image

imagetransfer script --------------------- +====================

.. automodule:: scripts.imagetransfer

interwiki script ----------------- +================

.. automodule:: scripts.interwiki

interwikidata script --------------------- +====================

.. automodule:: scripts.interwikidata

listpages script ----------------- +================

.. automodule:: scripts.listpages

misspelling script ------------------- +==================

.. automodule:: scripts.misspelling

movepages script ----------------- +================

.. automodule:: scripts.movepages

newitem script --------------- +==============

.. automodule:: scripts.newitem

noreferences script -------------------- +===================

.. automodule:: scripts.noreferences

nowcommons script ------------------ +=================

.. automodule:: scripts.nowcommons

pagefromfile script -------------------- +===================

.. automodule:: scripts.pagefromfile

parser_function_count script ------------------------------- +==============================

.. automodule:: scripts.parser_function_count

patrol script -------------- +=============

.. automodule:: scripts.patrol

protect script --------------- +==============

.. automodule:: scripts.protect

redirect script ---------------- +===============

.. automodule:: scripts.redirect

reflinks script ---------------- +===============

.. automodule:: scripts.reflinks

replace script --------------- +==============

.. automodule:: scripts.replace

replicate_wiki script ----------------------- +======================

.. automodule:: scripts.replicate_wiki

revertbot script ----------------- +================

.. automodule:: scripts.revertbot

solve_disambiguation script ----------------------------- +============================

.. automodule:: scripts.solve_disambiguation

speedy_delete script ---------------------- +=====================

.. automodule:: scripts.speedy_delete

template script ---------------- +===============

.. automodule:: scripts.template

templatecount script --------------------- +====================

.. automodule:: scripts.templatecount

touch script ------------- +============

.. automodule:: scripts.touch

transferbot script ------------------- +==================

.. automodule:: scripts.transferbot

unusedfiles script ------------------- +==================

.. automodule:: scripts.unusedfiles

upload script -------------- +=============

.. automodule:: scripts.upload

watchlist script ----------------- +================

.. automodule:: scripts.watchlist

weblinkchecker script ---------------------- +=====================

.. automodule:: scripts.weblinkchecker

welcome script --------------- +==============

.. automodule:: scripts.welcome

Script subpackages ------------------- +==================

For information on contents of subpackages, see

diff --git a/docs/scripts_ref/scripts.userscripts.rst b/docs/scripts_ref/scripts.userscripts.rst index 11f5130..471e6df 100644 --- a/docs/scripts_ref/scripts.userscripts.rst +++ b/docs/scripts_ref/scripts.userscripts.rst @@ -1,4 +1,5 @@ +********************************** User scripts - scripts.userscripts -================================== +**********************************

.. automodule:: scripts.userscripts diff --git a/docs/tests_ref/index.rst b/docs/tests_ref/index.rst index b0d289c..b957ade 100644 --- a/docs/tests_ref/index.rst +++ b/docs/tests_ref/index.rst @@ -1,6 +1,6 @@ -=============== +############### Tests reference -=============== +###############

.. include:: ../../tests/README.rst

diff --git a/docs/utilities/install.rst b/docs/utilities/install.rst index 794c9b9..ba13e72 100644 --- a/docs/utilities/install.rst +++ b/docs/utilities/install.rst @@ -1,17 +1,18 @@ +***************** Installer scripts -================= +*****************

make_dist script ------------------ +=================

.. automodule:: make_dist

setup script ------------- +============

.. automodule:: setup

entry point ------------ +===========

.. automodule:: pwb diff --git a/docs/utilities/scripts.rst b/docs/utilities/scripts.rst index 5c179f6..474bca9 100644 --- a/docs/utilities/scripts.rst +++ b/docs/utilities/scripts.rst @@ -1,54 +1,55 @@ +************************* Framework utility scripts -===================================== +*************************

.. automodule:: pywikibot.scripts :no-members: :noindex:

pwb wrapper script ------------------------------- +==================

.. automodule:: pywikibot.scripts.wrapper :no-members: :noindex:

generate_family_file script ------------------------------------------ +=============================

.. automodule:: pywikibot.scripts.generate_family_file :no-members: :noindex:

generate_user_files script ----------------------------------------- +============================

.. automodule:: pywikibot.scripts.generate_user_files :no-members: :noindex:

login script ------------------------- +============

.. automodule:: pywikibot.scripts.login :no-members: :noindex:

preload_sites script --------------------------------- +====================

.. automodule:: pywikibot.scripts.preload_sites :no-members: :noindex:

shell script ------------------------- +============

.. automodule:: pywikibot.scripts.shell :no-members: :noindex:

version script --------------------------- +==============

.. automodule:: pywikibot.scripts.version :no-members: diff --git a/docs/utilities/scripts_ref.rst b/docs/utilities/scripts_ref.rst index 1b25394..d5acf52 100644 --- a/docs/utilities/scripts_ref.rst +++ b/docs/utilities/scripts_ref.rst @@ -1,48 +1,49 @@ +*********************************** Framework utility scripts reference -=================================== +***********************************

.. automodule:: pywikibot.scripts :synopsis: Folder which holds framework scripts :private-members:

pwb wrapper script ------------------- +==================

.. automodule:: pywikibot.scripts.wrapper :synopsis: Wrapper script to invoke pywikibot-based scripts

generate_family_file script ------------------------------ +=============================

.. automodule:: pywikibot.scripts.generate_family_file :synopsis: This script generates a family file from a given URL

generate_user_files script ----------------------------- +============================

.. automodule:: pywikibot.scripts.generate_user_files :synopsis: Script to create user-config.py

login script ------------- +============

.. automodule:: pywikibot.scripts.login :synopsis: Script to log the bot in to a wiki account

preload_sites script --------------------- +====================

.. automodule:: pywikibot.scripts.preload_sites :synopsis: Script that preloads site and user info for all sites of given family

shell script ------------- +============

.. automodule:: pywikibot.scripts.shell :synopsis: Spawns an interactive Python shell and imports the pywikibot library

version script --------------- +==============

.. automodule:: pywikibot.scripts.version :synopsis: Script to determine the Pywikibot version (tag, revision and date)