jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/676659 )
Change subject: [doc] Use predefined substitutions ......................................................................
[doc] Use predefined substitutions
Bug: T279179 Change-Id: Iba2f445e331ad61f8ae1a3fc9b1a8ed418d87045 --- M CODE_OF_CONDUCT.rst M README.rst A docs/.rstcheck.cfg M docs/index.rst M tox.ini 5 files changed, 11 insertions(+), 6 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst index ea6ab54..3615c22 100644 --- a/CODE_OF_CONDUCT.rst +++ b/CODE_OF_CONDUCT.rst @@ -1,5 +1,6 @@ Code of Conduct ---------------
-The development of this software is covered by a `Code of Conduct https://www.mediawiki.org/wiki/Code_of_Conduct`_. +The development of this software is covered by a +`Code of Conduct https://www.mediawiki.org/wiki/Code_of_Conduct`_.
diff --git a/README.rst b/README.rst index 86253d5..6b1a91f 100644 --- a/README.rst +++ b/README.rst @@ -50,6 +50,7 @@ python pwb.py script_name
Or to install using PyPI (excluding scripts) + ::
pip install -U setuptools diff --git a/docs/.rstcheck.cfg b/docs/.rstcheck.cfg new file mode 100644 index 0000000..c4c9400 --- /dev/null +++ b/docs/.rstcheck.cfg @@ -0,0 +1,3 @@ +[rstcheck] +ignore_directives=automodule,autoclass,autofunction +ignore_messages=(Undefined substitution referenced: "(release|today|version)") \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 22ceaa0..2edeb3f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ -Pywikibot 6.1.0 Documentation -============================= +Pywikibot Documentation +=======================
-Welcome! This is the documentation for Pywikibot 6.1.0. +Welcome! This is the documentation for Pywikibot |release|.
.. note::
@@ -17,7 +17,7 @@ Wikipedia, it is now used throughout the Wikimedia Foundation's projects and on many other MediaWiki wikis.
-The project started in 2003 and is currently on core version 6.1.0. +The project started in 2003 and is currently on core version |version|. It features full API usage and is up-to-date with new MediaWiki features and a Pythonic package layout. But it also works with older installations of MediaWiki 1.23 or higher. diff --git a/tox.ini b/tox.ini index a9b7962..032eb03 100644 --- a/tox.ini +++ b/tox.ini @@ -63,7 +63,7 @@ [testenv:doc] commands = sphinx-build -M html ./docs ./docs/_build - rstcheck --recursive --report warning --ignore-directives automodule,autoclass,autofunction . + rstcheck --recursive --report warning . basepython = python3 deps = -rrequirements.txt