jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/692846 )
Change subject: [docs] Add a glossary to docs ......................................................................
[docs] Add a glossary to docs
Change-Id: Ia31b2ecd5d180e212414126151d0c01ed058370f --- A docs/glossary.rst M docs/index.rst 2 files changed, 62 insertions(+), 0 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 0000000..1adafff --- /dev/null +++ b/docs/glossary.rst @@ -0,0 +1,61 @@ +Glossary +======== + +.. if you add new entries, keep the alphabetical sorting! + +.. glossary:: + + ``>>>`` + The default Python prompt of the interactive Pywikibot shell. + Often seen for code examples which can be executed interactively + in the interpreter. The :mod:`pywikibot` module is preloaded. The + :mod:`scripts.shell` script is part of the :mod:`scripts` module. + + compat + The first Pywikibot package formerly known as *Pywikipediabot* + also called :term:`trunk` was started in 2003. MediaWiki didn't + have an API so a `screen scrapping + https://en.wikipedia.org/Screen_scraper`_ was used. + + core + In 2007 a new branch of Pywikibot formerly known as + :term:`trunk` was started using the new MediaWiki API. The + current release is |release|. + + master + The development branch of Pywikibot. It should not be used for + production systems, use :term:`stable` instead. The master branch + may have untested features. Use master branch if you want to + support development and report undetected problems. + + pwb + Can refer to: + + - short for Pywikibot + - the :mod:`pwb` wrapper script + + pywikibot + **Py**\ thon Media\ **Wiki Bot** Framework, a Python library and + collection of scripts that automate work on MediaWiki sites. + Originally designed for Wikipedia, it is now used throughout the + Wikimedia Foundation's projects and on many other wikis based of + MediaWiki software. + + rewrite + A former name of :term:`core`. + + stable + A stable branch of Pywikibot updated roughly every month + after tests passes. This branch is preinstalled at :term:`PAWS` + and should be used for production systems. + + trunk + A former name of :term:`compat`. + + PAWS + PAWS (PAWS: A Web Shell) formerly known as *Pywikibot: A Web Shell* + is a Jupyter notebooks deployment hosted by Wikimedia. It has + preinstalled the :term:`stable` release of Pywikibot. Refer: + + - https://wikitech.wikimedia.org/wiki/PAWS + - https://www.mediawiki.org/wiki/Manual:Pywikibot/PAWS \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 8db7805..e6cb09a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -79,6 +79,7 @@ .. toctree:: :maxdepth: 1
+ glossary changelog licenses credits