jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/703029 )
Change subject: [doc] start a faq page with sphinx ......................................................................
[doc] start a faq page with sphinx
Change-Id: I9830e195e4642cd8b6ae41219141ba25e4fa62eb --- A docs/faq.rst M docs/index.rst 2 files changed, 43 insertions(+), 0 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 0000000..04f0311 --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,42 @@ +Frequent Asked Questions +======================== +**How to speed up Pywikibot?** + 1. The first time you are using Pywikibot for multiple Wikimedia sites you + can run :py:mod:`preload_sites <scripts.maintenance.preload_sites>` script + to preload site info quickly. + 2. If you need the content, use :py:mod:`PreloadingGenerator + <pywikibot.pagegenerators.PreloadingGenerator>` with page generators, + :py:mod:`EntityGenerator <pywikibot.pagegenerators.EntityGenerator>` + for wikibase entities and :py:mod:`DequePreloadingGenerator + <pywikibot.pagegenerators.DequePreloadingGenerator>` for a + :py:mod:`DequeGenerator <pywikibot.tools.DequeGenerator>`. + 3. If you use :py:mod:`GeneratorFactory + <pywikibot.pagegenerators.GeneratorFactory>` with your bot and use its + :py:mod:`getCombinedGenerator + <pywikibot.pagegenerators.GeneratorFactory.getCombinedGenerator>` method + you can set ``preload=True`` to preload page content. This is an alternate + to the ``PreloadingGenerator`` function mentioned above. + 4. Use :py:mod:`MySQLPageGenerator + <pywikibot.pagegenerators.MySQLPageGenerator >` if direct DB access is + available and appropriate. See also: `MySQL`_ + +**The bot cannot delete pages** + Your account needs delete rights on your wiki. If you have setup another + account in your user_config use ``-user`` + :ref:`global option <global options>` to change it. + Maybe you have to login first. + +**ERROR: Unable to execute script because no *generator* was defined.** + Using ``-help`` option is a good way to find all generators which can be + used with that script. You can also find all generator options and filter + options at :py:mod:`pywikibot.pagegenerators` module. + See also `Page Generators`_ MediaWiki page for additional information. + +**pywikibot.i18n.TranslationError: No English translation has been defined** + It can happen due to lack of i18n submodule or files. Update i18n submodule + or download these files first. See also: `i18n submodule`_ + + +.. _i18n submodule: https://www.mediawiki.org/wiki/Manual:Pywikibot/i18n +.. _MySQL: https://www.mediawiki.org/wiki/Manual:Pywikibot/MySQL +.. _Page Generators: https://www.mediawiki.org/wiki/Manual:Pywikibot/Page_Generators diff --git a/docs/index.rst b/docs/index.rst index a428078..581e23f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,6 +46,7 @@ utilities/index scripts/index global_options + faq getting_help