[Pywikibot-commits] [Gerrit] Minor improvements in README.rst - change (pywikibot/core)

jenkins-bot has submitted this change and it was merged. Change subject: Minor improvements in README.rst ...................................................................... Minor improvements in README.rst - Add link to doc.wikimedia.org for further documentation in a more visible place. - Add commands to install pywikibot via PyPI Change-Id: Ica65a16befbe1a6fe7471a3ac44c5ca7ae5fe135 --- M README.rst 1 file changed, 8 insertions(+), 2 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/README.rst b/README.rst index 93a1135..08a1991 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,9 @@ Also included are various general function scripts that can be adapted for different tasks. +For further information about the library excluding scripts see +the full `code documentation <https://doc.wikimedia.org/pywikibot/>`_. + Quick start ----------- @@ -17,6 +20,11 @@ cd core git submodule update --init python pwb.py script_name + +Or to install using PyPI (excluding scripts) +:: + + pip install pywikibot --pre Our `installation guide <https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Pywikibot/Installation>`_ @@ -34,8 +42,6 @@ page = pywikibot.Page(site, 'Wikipedia:Sandbox') page.text = page.text.replace('foo', 'bar') page.save('Replacing "foo" with "bar"') # Saves the page - -For more documentation on pywikibot see our `docs <https://doc.wikimedia.org/pywikibot/>`_. Required external programms --------------------------- -- To view, visit https://gerrit.wikimedia.org/r/227211 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ica65a16befbe1a6fe7471a3ac44c5ca7ae5fe135 Gerrit-PatchSet: 4 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Ladsgroup &lt;ladsgroup(a)gmail.com&gt; Gerrit-Reviewer: John Vandenberg &lt;jayvdb(a)gmail.com&gt; Gerrit-Reviewer: Merlijn van Deen &lt;valhallasw(a)arctus.nl&gt; Gerrit-Reviewer: Ricordisamoa &lt;ricordisamoa(a)openmailbox.org&gt; Gerrit-Reviewer: XZise &lt;CommodoreFabianus(a)gmx.de&gt; Gerrit-Reviewer: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: jenkins-bot <>