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

Change subject: [doc] fix documentation ......................................................................

[doc] fix documentation

Change-Id: I8e286b45e5e9a503860813e4b0540e229fff2336 --- M docs/api_ref/pywikibot.config.rst M docs/installation.rst M scripts/maintenance/make_i18n_dict.py 3 files changed, 9 insertions(+), 5 deletions(-)

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

diff --git a/docs/api_ref/pywikibot.config.rst b/docs/api_ref/pywikibot.config.rst index c31852a..3e566c7 100644 --- a/docs/api_ref/pywikibot.config.rst +++ b/docs/api_ref/pywikibot.config.rst @@ -5,7 +5,6 @@ ^^^^^^^^^^^^^

.. automodule:: pywikibot.config - :noindex:

Option setting ^^^^^^^^^^^^^^ diff --git a/docs/installation.rst b/docs/installation.rst index b943842..eda7c20 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -14,8 +14,9 @@ .. literalinclude:: ../user-config.py.sample

This sample is shipped with the repository but is not available with -the site-package. For more settings use :mod:`generate_user_files` script -or refer :mod:`pywikibot.config`. +the site-package. For more settings use +:mod:`generate_user_files<pywikibot.scripts.generate_user_files>` script +or refer :py:mod:`pywikibot.config` module.

.. note:: Please also see the documentation at :manpage:`Installation` diff --git a/scripts/maintenance/make_i18n_dict.py b/scripts/maintenance/make_i18n_dict.py index c59d545..9fe0f56 100755 --- a/scripts/maintenance/make_i18n_dict.py +++ b/scripts/maintenance/make_i18n_dict.py @@ -3,24 +3,28 @@ Generate an i18n file from a given script.

run IDLE at topmost level: +

...

...

import pwb from scripts.maintenance.make_i18n_dict import i18nBot bot = i18nBot('<scriptname>', '<msg dict>') bot.run()

If you have more than one message dictionary, give all these names to the bot: +

...

...

bot = i18nBot('<scriptname>', '<msg dict1>', '<msg dict2>', '<msg dict3>')

If you want to rename the message index use keyword arguments. This may be mixed with preleading positonal arguments: +

...

...

bot = i18nBot('<scriptname>', '<msg dict1>', the_other_msg='<msg dict2>')

If you have the messages as instance constants you may call the bot as follows: ->>> bot = i18nBot( -... '<scriptname>.<class instance>', '<msg dict1>', '<msg dict2>') + +>>> bot = i18nBot('<scriptname>.<class name>', '<msg dict1>', '<msg dict2>')

It's also possible to make json files too by using to_json method after instantiating the bot. It also calls ``bot.run()`` to create the dictionaries: +

...

...

bot.to_json()

""" #