Template:Doc/pywikibot

Content of this page might be outdated or incomplete. For an up-to-date description of this script, see:
Which documentation should I use?

If you are using bots but not developing your own, use the short documentation. If you are contributing to Pywikibot, use the detailed documentation.

If you downloaded Pywikibot from PyPI using pip, or downloaded a release in an archive, use documentation for the stable release. If you cloned Pywikibot code directly and didn't change the code branch, use the development version.

Displays a Note with links to Pywikibot scripts documentation on doc.wikimedia.org

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Link suffixlink

Last two parts (page and anchor) of the link to the documentation of the script in Pywikibot user guide

Default
main.html#category-script
Example
main.html#category-script
Stringrequired
Script namescript

Name of the script (without the extension)

Default
category
Example
category
Stringrequired