jenkins-bot submitted this change.
[doc] Add user-config.py.sample to sphinx doc
Change-Id: I8392adda91440361c9d8c8d45c7c270316ee11b8
---
M README.rst
M docs/installation.rst
2 files changed, 13 insertions(+), 2 deletions(-)
diff --git a/README.rst b/README.rst
index d23d3eb..5bb3aee 100644
--- a/README.rst
+++ b/README.rst
@@ -142,8 +142,6 @@
main()
--------------------------------------------------------------------------------------------
-
For more documentation on Pywikibot see our `docs <https://doc.wikimedia.org/pywikibot/>`_.
diff --git a/docs/installation.rst b/docs/installation.rst
index 4089a5b..74ba2f5 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -4,6 +4,19 @@
.. include:: ../README.rst
:end-before: For more documentation on Pywikibot
+Settings
+--------
+
+It is recommended to create a `user-config.py` file if Pywikibot is used as a
+site package. If Pywikibot is used in directory mode e.g. from a repository
+the configuration file is mandatory. A minimal sample is shown below.
+
+.. 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
+(not available with site-package) or refer :mod:`pywikibot.config`.
+
.. note::
Please also see the documentation at
`Manual:Pywikibot/Installation <https://www.mediawiki.org/wiki/Manual:Pywikibot/Installation>`_
To view, visit change 702900. To unsubscribe, or for help writing mail filters, visit settings.