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

Change subject: [sphinx] Update doc for sphinx ......................................................................

[sphinx] Update doc for sphinx

Change-Id: Iebba4f21657def4a385fc6272d56c5f45f786ad7 --- M CREDITS.rst M docs/api_ref/pywikibot.specialbots.rst M docs/api_ref/pywikibot.tools.rst M docs/api_ref/pywikibot.userinterfaces.rst M docs/changelog.rst M docs/licenses.rst 6 files changed, 35 insertions(+), 35 deletions(-)

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

diff --git a/CREDITS.rst b/CREDITS.rst index 84ed971..3da628b 100644 --- a/CREDITS.rst +++ b/CREDITS.rst @@ -1,4 +1,4 @@ -**Pywikibot** is an open-source project that cannot exist without your +**Pywikibot is an open-source project** that cannot exist without your contributions. We would therefore like to thank everyone who has contributed:

diff --git a/docs/api_ref/pywikibot.specialbots.rst b/docs/api_ref/pywikibot.specialbots.rst index 901605d..8208d51 100644 --- a/docs/api_ref/pywikibot.specialbots.rst +++ b/docs/api_ref/pywikibot.specialbots.rst @@ -1,4 +1,4 @@ -pywikibot.specialbots package -============================= +specialbots package +===================

.. automodule:: pywikibot.specialbots diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst index 6161292..178af38 100644 --- a/docs/api_ref/pywikibot.tools.rst +++ b/docs/api_ref/pywikibot.tools.rst @@ -1,22 +1,19 @@ -pywikibot.tools package -======================= - +tools package +============= + .. automodule:: pywikibot.tools

-Submodules ----------- - -pywikibot.tools.chars module ----------------------------- +tools.chars module +------------------

.. automodule:: pywikibot.tools.chars

-pywikibot.tools.djvu module ---------------------------- +tools.djvu module +-----------------

.. automodule:: pywikibot.tools.djvu

-pywikibot.tools.formatter module --------------------------------- +tools.formatter module +----------------------

.. automodule:: pywikibot.tools.formatter diff --git a/docs/api_ref/pywikibot.userinterfaces.rst b/docs/api_ref/pywikibot.userinterfaces.rst index 3dc96ac..486ae00 100644 --- a/docs/api_ref/pywikibot.userinterfaces.rst +++ b/docs/api_ref/pywikibot.userinterfaces.rst @@ -1,43 +1,40 @@ -pywikibot.userinterfaces package -================================ +userinterfaces package +======================

.. automodule:: pywikibot.userinterfaces

-Submodules +gui module ----------

-pywikibot.userinterfaces.gui module ------------------------------------ - .. automodule:: pywikibot.userinterfaces.gui

-pywikibot.userinterfaces.terminal_interface module ---------------------------------------------------- +terminal_interface module +--------------------------

.. automodule:: pywikibot.userinterfaces.terminal_interface

-pywikibot.userinterfaces.terminal_interface_base module ---------------------------------------------------------- +terminal_interface_base module +--------------------------------

.. automodule:: pywikibot.userinterfaces.terminal_interface_base

-pywikibot.userinterfaces.terminal_interface_unix module ---------------------------------------------------------- +terminal_interface_unix module +--------------------------------

.. automodule:: pywikibot.userinterfaces.terminal_interface_unix

-pywikibot.userinterfaces.terminal_interface_win32 module ----------------------------------------------------------- +terminal_interface_win32 module +---------------------------------

.. automodule:: pywikibot.userinterfaces.terminal_interface_win32

-pywikibot.userinterfaces.transliteration module ------------------------------------------------ +transliteration module +----------------------

.. automodule:: pywikibot.userinterfaces.transliteration

-pywikibot.userinterfaces.win32_unicode module ----------------------------------------------- +win32_unicode module +---------------------

.. automodule:: pywikibot.userinterfaces.win32_unicode

diff --git a/docs/changelog.rst b/docs/changelog.rst index 58a6d2e..6840fb0 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,6 +1,10 @@ +:tocdepth: 3 + Change log ==========

+**Current version:** |release| + .. include:: ../ROADMAP.rst

.. include:: ../HISTORY.rst diff --git a/docs/licenses.rst b/docs/licenses.rst index e5c958a..d0dbf66 100644 --- a/docs/licenses.rst +++ b/docs/licenses.rst @@ -1,7 +1,9 @@ +:tocdepth: 1 + Licenses ========

-The framework itself and this documentation are available under the +**The framework itself and this documentation** are available under the :ref:`MIT license <licenses-MIT>`; manual pages on mediawiki.org are available under the `CC-BY-SA 3.0`_ license. The Pywikibot logo is available under the `CC-BY-SA 4.0`_ license. @@ -10,7 +12,7 @@

MIT License ----------- -The framework is available under the MIT license: +**The framework is available under the MIT license.**

.. include:: ../LICENSE