jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/426820 )
Change subject: [IMPR][doc] Major update and fixup of docs ......................................................................
[IMPR][doc] Major update and fixup of docs
- regenerate and update apidoc templates, add missing templates, remove obsolete and duplicate templates (T192255) - switch from numpydoc to napoleon (T187009) - napoleon is more faster and more efficient than numpydoc. Many warnings and errors in Jenkins came from numpydoc building some parts twice when not necessary, which napoleon effectively overcomes. It is also fully compatible with numpydoc, therefore no major changes are needed - fix errors in doc comments leading to missing, failing or broken docs: - escape "=" (T192245) - remove double spaces - fix wrongly named user-config.py and scripts/surnames_redirects.py files - rename README files to same rst format as others, remove redundant README file (its content is already in parent folder)
All these points reduce number of errors and doc warnings from 75 000 to cca 300 warnings. It also reduces the doc test time from 6m to 2m.
Bug: T192255 Bug: T187009 Bug: T192245 Change-Id: Id20791554e643fa22a74f2a901eacaaa8ae9c6ee --- M docs/Makefile M docs/api_ref/pywikibot.comms.rst M docs/api_ref/pywikibot.compat.rst M docs/api_ref/pywikibot.data.rst M docs/api_ref/pywikibot.families.rst M docs/api_ref/pywikibot.rst M docs/api_ref/pywikibot.tools.rst M docs/api_ref/pywikibot.userinterfaces.rst A docs/api_ref/tests/add_text_tests.rst M docs/api_ref/tests/api_tests.rst M docs/api_ref/tests/archivebot_tests.rst A docs/api_ref/tests/aspects.rst A docs/api_ref/tests/basepage_tests.rst A docs/api_ref/tests/bot_tests.rst A docs/api_ref/tests/cache_tests.rst A docs/api_ref/tests/category_bot_tests.rst A docs/api_ref/tests/category_tests.rst A docs/api_ref/tests/checkimages_tests.rst A docs/api_ref/tests/conftest.rst A docs/api_ref/tests/cosmetic_changes_tests.rst M docs/api_ref/tests/data_ingestion_tests.rst M docs/api_ref/tests/date_tests.rst A docs/api_ref/tests/deletionbot_tests.rst M docs/api_ref/tests/deprecation_tests.rst A docs/api_ref/tests/diff_tests.rst A docs/api_ref/tests/disambredir_tests.rst A docs/api_ref/tests/djvu_tests.rst M docs/api_ref/tests/dry_api_tests.rst M docs/api_ref/tests/dry_site_tests.rst M docs/api_ref/tests/edit_failure_tests.rst A docs/api_ref/tests/edit_tests.rst A docs/api_ref/tests/eventstreams_tests.rst A docs/api_ref/tests/exceptions_tests.rst M docs/api_ref/tests/family_tests.rst M docs/api_ref/tests/file_tests.rst A docs/api_ref/tests/fixes_tests.rst M docs/api_ref/tests/flow_edit_tests.rst M docs/api_ref/tests/flow_tests.rst A docs/api_ref/tests/flow_thanks_tests.rst M docs/api_ref/tests/http_tests.rst A docs/api_ref/tests/i18n.pywikibot.rst A docs/api_ref/tests/i18n.rst M docs/api_ref/tests/i18n_tests.rst A docs/api_ref/tests/imagecopy_tests.rst M docs/api_ref/tests/index.rst A docs/api_ref/tests/interwiki_graph_tests.rst M docs/api_ref/tests/interwiki_link_tests.rst A docs/api_ref/tests/interwikidata_tests.rst A docs/api_ref/tests/isbn_tests.rst A docs/api_ref/tests/l10n_tests.rst M docs/api_ref/tests/link_tests.rst A docs/api_ref/tests/logentry_tests.rst A docs/api_ref/tests/login_tests.rst M docs/api_ref/tests/mediawikiversion_tests.rst M docs/api_ref/tests/namespace_tests.rst M docs/api_ref/tests/oauth_tests.rst M docs/api_ref/tests/page_tests.rst M docs/api_ref/tests/pagegenerators_tests.rst A docs/api_ref/tests/paraminfo_tests.rst A docs/api_ref/tests/patrolbot_tests.rst A docs/api_ref/tests/plural_tests.rst A docs/api_ref/tests/proofreadpage_tests.rst A docs/api_ref/tests/protectbot_tests.rst A docs/api_ref/tests/pwb.print_env.rst A docs/api_ref/tests/pwb.print_locals.rst A docs/api_ref/tests/pwb.print_unicode.rst A docs/api_ref/tests/pwb.rst M docs/api_ref/tests/pwb_tests.rst A docs/api_ref/tests/python_tests.rst A docs/api_ref/tests/redirect_bot_tests.rst A docs/api_ref/tests/reflinks_tests.rst A docs/api_ref/tests/replacebot_tests.rst M docs/api_ref/tests/script_tests.rst A docs/api_ref/tests/site_detect_tests.rst M docs/api_ref/tests/site_tests.rst A docs/api_ref/tests/sparql_tests.rst A docs/api_ref/tests/template_bot_tests.rst A docs/api_ref/tests/tests.rst A docs/api_ref/tests/tests_tests.rst M docs/api_ref/tests/textlib_tests.rst A docs/api_ref/tests/thanks_tests.rst M docs/api_ref/tests/thread_tests.rst A docs/api_ref/tests/timestamp_tests.rst M docs/api_ref/tests/timestripper_tests.rst A docs/api_ref/tests/tk_tests.rst M docs/api_ref/tests/tools_chars_tests.rst A docs/api_ref/tests/tools_formatter_tests.rst M docs/api_ref/tests/tools_ip_tests.rst A docs/api_ref/tests/tools_tests.rst A docs/api_ref/tests/ui_options_tests.rst M docs/api_ref/tests/ui_tests.rst M docs/api_ref/tests/upload_tests.rst A docs/api_ref/tests/uploadbot_tests.rst A docs/api_ref/tests/user_tests.rst A docs/api_ref/tests/utils.rst M docs/api_ref/tests/weblib_tests.rst A docs/api_ref/tests/weblinkchecker_tests.rst M docs/api_ref/tests/wikibase_edit_tests.rst M docs/api_ref/tests/wikibase_tests.rst M docs/api_ref/tests/wikistats_tests.rst M docs/api_ref/tests/xmlreader_tests.rst M docs/conf.py M docs/index.rst M docs/make.bat M docs/requirements-py3.txt D docs/scripts.maintenance.rst A docs/scripts/scripts.archive.rst M docs/scripts/scripts.maintenance.rst M docs/scripts/scripts.rst A docs/scripts/scripts.userscripts.rst M pywikibot/bot.py M pywikibot/comms/eventstreams.py M pywikibot/config2.py M pywikibot/families/lyricwiki_family.py M pywikibot/pagegenerators.py M scripts/README.rst R scripts/archive/README.rst M scripts/archivebot.py M scripts/harvest_template.py D scripts/maintenance/README M scripts/protect.py M scripts/replicate_wiki.py M scripts/wikisourcetext.py M tests/script_tests.py 124 files changed, 1,194 insertions(+), 1,174 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/docs/Makefile b/docs/Makefile index 29248dc..6f63c8c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,153 +1,20 @@ -# Makefile for Sphinx documentation +# Minimal makefile for Sphinx documentation #
# You can set these variables from the command line. SPHINXOPTS = -a -SPHINXBUILD = python3.4 `which sphinx-build` -PAPER = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Pywikibot +SOURCEDIR = . BUILDDIR = _build
-# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - +# Put it first so that "make" without argument is like "make help". help: - @echo "Please use `make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-clean: - -rm -rf $(BUILDDIR)/* +.PHONY: help Makefile
-html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Pywikibot.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Pywikibot.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Pywikibot" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Pywikibot" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run `make' in that directory to run these through (pdf)latex" \ - "(use `make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run `make' in that directory to run these through makeinfo" \ - "(use `make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/api_ref/pywikibot.comms.rst b/docs/api_ref/pywikibot.comms.rst index e4aeccb..4fa8978 100644 --- a/docs/api_ref/pywikibot.comms.rst +++ b/docs/api_ref/pywikibot.comms.rst @@ -32,3 +32,5 @@ :members: :undoc-members: :show-inheritance: + + diff --git a/docs/api_ref/pywikibot.compat.rst b/docs/api_ref/pywikibot.compat.rst index d059d1a..0695049 100644 --- a/docs/api_ref/pywikibot.compat.rst +++ b/docs/api_ref/pywikibot.compat.rst @@ -32,3 +32,5 @@ :members: :undoc-members: :show-inheritance: + + diff --git a/docs/api_ref/pywikibot.data.rst b/docs/api_ref/pywikibot.data.rst index a42e13e..0c98b8e 100644 --- a/docs/api_ref/pywikibot.data.rst +++ b/docs/api_ref/pywikibot.data.rst @@ -17,6 +17,21 @@ :undoc-members: :show-inheritance:
+pywikibot.data.mysql module +--------------------------- + +.. automodule:: pywikibot.data.mysql + :members: + :undoc-members: + :show-inheritance: + +pywikibot.data.sparql module +---------------------------- + +.. automodule:: pywikibot.data.sparql + :members: + :undoc-members: + :show-inheritance:
pywikibot.data.wikistats module ------------------------------- @@ -25,3 +40,5 @@ :members: :undoc-members: :show-inheritance: + + diff --git a/docs/api_ref/pywikibot.families.rst b/docs/api_ref/pywikibot.families.rst index d77d28b..d830f43 100644 --- a/docs/api_ref/pywikibot.families.rst +++ b/docs/api_ref/pywikibot.families.rst @@ -9,218 +9,220 @@ Submodules ----------
-pywikibot.families.commons_family module ----------------------------------------- +pywikibot.families.commons_family module +-----------------------------------------
.. automodule:: pywikibot.families.commons_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.i18n_family module -------------------------------------- +pywikibot.families.i18n_family module +--------------------------------------
.. automodule:: pywikibot.families.i18n_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.incubator_family module ------------------------------------------- +pywikibot.families.incubator_family module +-------------------------------------------
.. automodule:: pywikibot.families.incubator_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.lyricwiki_family module ------------------------------------------- +pywikibot.families.lyricwiki_family module +-------------------------------------------
.. automodule:: pywikibot.families.lyricwiki_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.mediawiki_family module ------------------------------------------- +pywikibot.families.mediawiki_family module +-------------------------------------------
.. automodule:: pywikibot.families.mediawiki_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.meta_family module -------------------------------------- +pywikibot.families.meta_family module +--------------------------------------
.. automodule:: pywikibot.families.meta_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.omegawiki_family module ------------------------------------------- +pywikibot.families.omegawiki_family module +-------------------------------------------
.. automodule:: pywikibot.families.omegawiki_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.osm_family module ------------------------------------- +pywikibot.families.osm_family module +-------------------------------------
.. automodule:: pywikibot.families.osm_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.outreach_family module ------------------------------------------ +pywikibot.families.outreach_family module +------------------------------------------
.. automodule:: pywikibot.families.outreach_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.species_family module ----------------------------------------- +pywikibot.families.species_family module +-----------------------------------------
.. automodule:: pywikibot.families.species_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.strategy_family module ------------------------------------------ +pywikibot.families.strategy_family module +------------------------------------------
.. automodule:: pywikibot.families.strategy_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.test_family module -------------------------------------- +pywikibot.families.test_family module +--------------------------------------
.. automodule:: pywikibot.families.test_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.vikidia_family module ----------------------------------------- +pywikibot.families.vikidia_family module +-----------------------------------------
.. automodule:: pywikibot.families.vikidia_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikia_family module --------------------------------------- +pywikibot.families.wikia_family module +---------------------------------------
.. automodule:: pywikibot.families.wikia_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikibooks_family module ------------------------------------------- +pywikibot.families.wikibooks_family module +-------------------------------------------
.. automodule:: pywikibot.families.wikibooks_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikidata_family module ------------------------------------------ +pywikibot.families.wikidata_family module +------------------------------------------
.. automodule:: pywikibot.families.wikidata_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikimania_family module ------------------------------------------- +pywikibot.families.wikimania_family module +-------------------------------------------
.. automodule:: pywikibot.families.wikimania_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikimediachapter_family module -------------------------------------------------- +pywikibot.families.wikimediachapter_family module +--------------------------------------------------
.. automodule:: pywikibot.families.wikimediachapter_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikinews_family module ------------------------------------------ +pywikibot.families.wikinews_family module +------------------------------------------
.. automodule:: pywikibot.families.wikinews_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikipedia_family module ------------------------------------------- +pywikibot.families.wikipedia_family module +-------------------------------------------
.. automodule:: pywikibot.families.wikipedia_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikiquote_family module ------------------------------------------- +pywikibot.families.wikiquote_family module +-------------------------------------------
.. automodule:: pywikibot.families.wikiquote_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikisource_family module -------------------------------------------- +pywikibot.families.wikisource_family module +--------------------------------------------
.. automodule:: pywikibot.families.wikisource_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikitech_family module ------------------------------------------ +pywikibot.families.wikitech_family module +------------------------------------------
.. automodule:: pywikibot.families.wikitech_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikiversity_family module --------------------------------------------- +pywikibot.families.wikiversity_family module +---------------------------------------------
.. automodule:: pywikibot.families.wikiversity_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wikivoyage_family module -------------------------------------------- +pywikibot.families.wikivoyage_family module +--------------------------------------------
.. automodule:: pywikibot.families.wikivoyage_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wiktionary_family module -------------------------------------------- +pywikibot.families.wiktionary_family module +--------------------------------------------
.. automodule:: pywikibot.families.wiktionary_family :members: :undoc-members: :show-inheritance:
-pywikibot.families.wowwiki_family module ----------------------------------------- +pywikibot.families.wowwiki_family module +-----------------------------------------
.. automodule:: pywikibot.families.wowwiki_family :members: :undoc-members: :show-inheritance: + + diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index d683df6..b111780 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -29,6 +29,14 @@ :undoc-members: :show-inheritance:
+pywikibot.bot_choice module +---------------------------- + +.. automodule:: pywikibot.bot_choice + :members: + :undoc-members: + :show-inheritance: + pywikibot.botirc module -----------------------
@@ -45,8 +53,8 @@ :undoc-members: :show-inheritance:
-pywikibot.cosmetic_changes module ---------------------------------- +pywikibot.cosmetic_changes module +----------------------------------
.. automodule:: pywikibot.cosmetic_changes :members: @@ -118,7 +126,7 @@ :show-inheritance:
pywikibot.flow module ----------------------- +---------------------
.. automodule:: pywikibot.flow :members: @@ -133,8 +141,8 @@ :undoc-members: :show-inheritance:
-pywikibot.interwiki_graph module --------------------------------- +pywikibot.interwiki_graph module +---------------------------------
.. automodule:: pywikibot.interwiki_graph :members: @@ -145,6 +153,14 @@ ---------------------------
.. automodule:: pywikibot.logentries + :members: + :undoc-members: + :show-inheritance: + +pywikibot.logging module +------------------------ + +.. automodule:: pywikibot.logging :members: :undoc-members: :show-inheritance: @@ -197,6 +213,22 @@ :undoc-members: :show-inheritance:
+pywikibot.site_detect module +----------------------------- + +.. automodule:: pywikibot.site_detect + :members: + :undoc-members: + :show-inheritance: + +pywikibot.specialbots module +---------------------------- + +.. automodule:: pywikibot.specialbots + :members: + :undoc-members: + :show-inheritance: + pywikibot.textlib module ------------------------
@@ -244,3 +276,5 @@ :members: :undoc-members: :show-inheritance: + + diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst index 990f665..3a432cb 100644 --- a/docs/api_ref/pywikibot.tools.rst +++ b/docs/api_ref/pywikibot.tools.rst @@ -17,6 +17,22 @@ :undoc-members: :show-inheritance:
+pywikibot.tools.djvu module +--------------------------- + +.. automodule:: pywikibot.tools.djvu + :members: + :undoc-members: + :show-inheritance: + +pywikibot.tools.formatter module +-------------------------------- + +.. automodule:: pywikibot.tools.formatter + :members: + :undoc-members: + :show-inheritance: + pywikibot.tools.ip module -------------------------
@@ -24,3 +40,5 @@ :members: :undoc-members: :show-inheritance: + + diff --git a/docs/api_ref/pywikibot.userinterfaces.rst b/docs/api_ref/pywikibot.userinterfaces.rst index 46d46bc..59f8a4d 100644 --- a/docs/api_ref/pywikibot.userinterfaces.rst +++ b/docs/api_ref/pywikibot.userinterfaces.rst @@ -9,8 +9,8 @@ Submodules ----------
-pywikibot.userinterfaces.cgi_interface module ---------------------------------------------- +pywikibot.userinterfaces.cgi_interface module +----------------------------------------------
.. automodule:: pywikibot.userinterfaces.cgi_interface :members: @@ -25,32 +25,32 @@ :undoc-members: :show-inheritance:
-pywikibot.userinterfaces.terminal_interface module --------------------------------------------------- +pywikibot.userinterfaces.terminal_interface module +---------------------------------------------------
.. automodule:: pywikibot.userinterfaces.terminal_interface :members: :undoc-members: :show-inheritance:
-pywikibot.userinterfaces.terminal_interface_base module -------------------------------------------------------- +pywikibot.userinterfaces.terminal_interface_base module +---------------------------------------------------------
.. automodule:: pywikibot.userinterfaces.terminal_interface_base :members: :undoc-members: :show-inheritance:
-pywikibot.userinterfaces.terminal_interface_unix module -------------------------------------------------------- +pywikibot.userinterfaces.terminal_interface_unix module +---------------------------------------------------------
.. automodule:: pywikibot.userinterfaces.terminal_interface_unix :members: :undoc-members: :show-inheritance:
-pywikibot.userinterfaces.terminal_interface_win32 module --------------------------------------------------------- +pywikibot.userinterfaces.terminal_interface_win32 module +----------------------------------------------------------
.. automodule:: pywikibot.userinterfaces.terminal_interface_win32 :members: @@ -65,10 +65,12 @@ :undoc-members: :show-inheritance:
-pywikibot.userinterfaces.win32_unicode module ---------------------------------------------- +pywikibot.userinterfaces.win32_unicode module +----------------------------------------------
.. automodule:: pywikibot.userinterfaces.win32_unicode :members: :undoc-members: :show-inheritance: + + diff --git a/docs/api_ref/tests/add_text_tests.rst b/docs/api_ref/tests/add_text_tests.rst new file mode 100644 index 0000000..bd2ad0b --- /dev/null +++ b/docs/api_ref/tests/add_text_tests.rst @@ -0,0 +1,7 @@ +tests.add_text_tests module +============================= + +.. automodule:: tests.add_text_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/api_tests.rst b/docs/api_ref/tests/api_tests.rst index e7e2ac3..6140faa 100644 --- a/docs/api_ref/tests/api_tests.rst +++ b/docs/api_ref/tests/api_tests.rst @@ -1,21 +1,7 @@ -========= -api_tests -========= - Tests in ``tests.api_tests``: +tests.api_tests module +=======================
---------------- -Available tests ---------------- - .. autoclass:: tests.api_tests.TestApiFunctions - :members: - .. autoclass:: tests.api_tests.TestDryApiFunctions - :members: - .. autoclass:: tests.api_tests.TestParamInfo - :members: - .. autoclass:: tests.api_tests.TestDryPageGenerator - :members: - .. autoclass:: tests.api_tests.TestPropertyGenerator - :members: - .. autoclass:: tests.api_tests.TestCachedRequest - :members: - +.. automodule:: tests.api_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/archivebot_tests.rst b/docs/api_ref/tests/archivebot_tests.rst index 4ba261b..9ba212b 100644 --- a/docs/api_ref/tests/archivebot_tests.rst +++ b/docs/api_ref/tests/archivebot_tests.rst @@ -1,11 +1,7 @@ -================ -archivebot_tests -================ - Tests in ``tests.archivebot_tests``: +tests.archivebot_tests module +==============================
---------------- -Available tests ---------------- - .. autoclass:: tests.archivebot_tests.TestArchiveBot - :members: - +.. automodule:: tests.archivebot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/aspects.rst b/docs/api_ref/tests/aspects.rst new file mode 100644 index 0000000..a99b064 --- /dev/null +++ b/docs/api_ref/tests/aspects.rst @@ -0,0 +1,7 @@ +tests.aspects module +==================== + +.. automodule:: tests.aspects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/basepage_tests.rst b/docs/api_ref/tests/basepage_tests.rst new file mode 100644 index 0000000..e1be084 --- /dev/null +++ b/docs/api_ref/tests/basepage_tests.rst @@ -0,0 +1,7 @@ +tests.basepage_tests module +============================ + +.. automodule:: tests.basepage_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/bot_tests.rst b/docs/api_ref/tests/bot_tests.rst new file mode 100644 index 0000000..6d8ef1d --- /dev/null +++ b/docs/api_ref/tests/bot_tests.rst @@ -0,0 +1,7 @@ +tests.bot_tests module +======================= + +.. automodule:: tests.bot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/cache_tests.rst b/docs/api_ref/tests/cache_tests.rst new file mode 100644 index 0000000..aa626f0 --- /dev/null +++ b/docs/api_ref/tests/cache_tests.rst @@ -0,0 +1,7 @@ +tests.cache_tests module +========================= + +.. automodule:: tests.cache_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/category_bot_tests.rst b/docs/api_ref/tests/category_bot_tests.rst new file mode 100644 index 0000000..0315c94 --- /dev/null +++ b/docs/api_ref/tests/category_bot_tests.rst @@ -0,0 +1,7 @@ +tests.category_bot_tests module +================================= + +.. automodule:: tests.category_bot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/category_tests.rst b/docs/api_ref/tests/category_tests.rst new file mode 100644 index 0000000..6cf03e8 --- /dev/null +++ b/docs/api_ref/tests/category_tests.rst @@ -0,0 +1,7 @@ +tests.category_tests module +============================ + +.. automodule:: tests.category_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/checkimages_tests.rst b/docs/api_ref/tests/checkimages_tests.rst new file mode 100644 index 0000000..655ff9c --- /dev/null +++ b/docs/api_ref/tests/checkimages_tests.rst @@ -0,0 +1,7 @@ +tests.checkimages_tests module +=============================== + +.. automodule:: tests.checkimages_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/conftest.rst b/docs/api_ref/tests/conftest.rst new file mode 100644 index 0000000..eb35650 --- /dev/null +++ b/docs/api_ref/tests/conftest.rst @@ -0,0 +1,7 @@ +tests.conftest module +===================== + +.. automodule:: tests.conftest + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/cosmetic_changes_tests.rst b/docs/api_ref/tests/cosmetic_changes_tests.rst new file mode 100644 index 0000000..5aea8a4 --- /dev/null +++ b/docs/api_ref/tests/cosmetic_changes_tests.rst @@ -0,0 +1,7 @@ +tests.cosmetic_changes_tests module +===================================== + +.. automodule:: tests.cosmetic_changes_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/data_ingestion_tests.rst b/docs/api_ref/tests/data_ingestion_tests.rst index 83e33bd..c50578c 100644 --- a/docs/api_ref/tests/data_ingestion_tests.rst +++ b/docs/api_ref/tests/data_ingestion_tests.rst @@ -1,13 +1,7 @@ -==================== -data_ingestion_tests -==================== - Tests in ``tests.data_ingestion_tests``: +tests.data_ingestion_tests module +===================================
---------------- -Available tests ---------------- - .. autoclass:: tests.data_ingestion_tests.TestCSVReader - :members: - .. autoclass:: tests.data_ingestion_tests.TestPhoto - :members: - +.. automodule:: tests.data_ingestion_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/date_tests.rst b/docs/api_ref/tests/date_tests.rst index f0d9b12..db42164 100644 --- a/docs/api_ref/tests/date_tests.rst +++ b/docs/api_ref/tests/date_tests.rst @@ -1,11 +1,7 @@ -========== -date_tests -========== - Tests in ``tests.date_tests``: +tests.date_tests module +========================
---------------- -Available tests ---------------- - .. autoclass:: tests.date_tests.TestDate - :members: - +.. automodule:: tests.date_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/deletionbot_tests.rst b/docs/api_ref/tests/deletionbot_tests.rst new file mode 100644 index 0000000..211bd25 --- /dev/null +++ b/docs/api_ref/tests/deletionbot_tests.rst @@ -0,0 +1,7 @@ +tests.deletionbot_tests module +=============================== + +.. automodule:: tests.deletionbot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/deprecation_tests.rst b/docs/api_ref/tests/deprecation_tests.rst index c8b85c2..8d6263c 100644 --- a/docs/api_ref/tests/deprecation_tests.rst +++ b/docs/api_ref/tests/deprecation_tests.rst @@ -1,13 +1,7 @@ -================= -deprecation_tests -================= - Tests in ``tests.deprecation_tests``: +tests.deprecation_tests module +===============================
---------------- -Available tests ---------------- - .. autoclass:: tests.deprecation_tests.DecoratorFullNameTestCase - :members: - .. autoclass:: tests.deprecation_tests.DeprecatorTestCase - :members: - +.. automodule:: tests.deprecation_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/diff_tests.rst b/docs/api_ref/tests/diff_tests.rst new file mode 100644 index 0000000..f1d1888 --- /dev/null +++ b/docs/api_ref/tests/diff_tests.rst @@ -0,0 +1,7 @@ +tests.diff_tests module +======================== + +.. automodule:: tests.diff_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/disambredir_tests.rst b/docs/api_ref/tests/disambredir_tests.rst new file mode 100644 index 0000000..a9223ee --- /dev/null +++ b/docs/api_ref/tests/disambredir_tests.rst @@ -0,0 +1,7 @@ +tests.disambredir_tests module +=============================== + +.. automodule:: tests.disambredir_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/djvu_tests.rst b/docs/api_ref/tests/djvu_tests.rst new file mode 100644 index 0000000..f333db9 --- /dev/null +++ b/docs/api_ref/tests/djvu_tests.rst @@ -0,0 +1,7 @@ +tests.djvu_tests module +======================== + +.. automodule:: tests.djvu_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/dry_api_tests.rst b/docs/api_ref/tests/dry_api_tests.rst index 200e705..32fa434 100644 --- a/docs/api_ref/tests/dry_api_tests.rst +++ b/docs/api_ref/tests/dry_api_tests.rst @@ -1,19 +1,7 @@ -============= -dry_api_tests -============= - Tests in ``tests.dry_api_tests``: +tests.dry_api_tests module +============================
---------------- -Available tests ---------------- - .. autoclass:: tests.dry_api_tests.DryCachedRequestTests - :members: - .. autoclass:: tests.dry_api_tests.DryMimeTests - :members: - .. autoclass:: tests.dry_api_tests.MimeTests - :members: - .. autoclass:: tests.dry_api_tests.MockCachedRequestKeyTests - :members: - .. autoclass:: tests.dry_api_tests.QueryGenTests - :members: - +.. automodule:: tests.dry_api_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/dry_site_tests.rst b/docs/api_ref/tests/dry_site_tests.rst index 80ba172..5167e82 100644 --- a/docs/api_ref/tests/dry_site_tests.rst +++ b/docs/api_ref/tests/dry_site_tests.rst @@ -1,15 +1,7 @@ -============== -dry_site_tests -============== - Tests in ``tests.dry_site_tests``: +tests.dry_site_tests module +=============================
---------------- -Available tests ---------------- - .. autoclass:: tests.dry_site_tests.TestDrySite - :members: - .. autoclass:: tests.dry_site_tests.TestMustBe - :members: - .. autoclass:: tests.dry_site_tests.TestNeedVersion - :members: - +.. automodule:: tests.dry_site_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/edit_failure_tests.rst b/docs/api_ref/tests/edit_failure_tests.rst index 844d705..6a2e41c 100644 --- a/docs/api_ref/tests/edit_failure_tests.rst +++ b/docs/api_ref/tests/edit_failure_tests.rst @@ -1,15 +1,7 @@ -================== -edit_failure_tests -================== - Tests in ``tests.edit_failure_tests``: +tests.edit_failure_tests module +=================================
---------------- -Available tests ---------------- - .. autoclass:: tests.edit_failure_tests.TestActionFailure - :members: - .. autoclass:: tests.edit_failure_tests.TestSaveFailure - :members: - .. autoclass:: tests.edit_failure_tests.TestWikibaseSaveTest - :members: - +.. automodule:: tests.edit_failure_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/edit_tests.rst b/docs/api_ref/tests/edit_tests.rst new file mode 100644 index 0000000..cafbd6a --- /dev/null +++ b/docs/api_ref/tests/edit_tests.rst @@ -0,0 +1,7 @@ +tests.edit_tests module +======================== + +.. automodule:: tests.edit_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/eventstreams_tests.rst b/docs/api_ref/tests/eventstreams_tests.rst new file mode 100644 index 0000000..50dfa72 --- /dev/null +++ b/docs/api_ref/tests/eventstreams_tests.rst @@ -0,0 +1,7 @@ +tests.eventstreams_tests module +================================ + +.. automodule:: tests.eventstreams_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/exceptions_tests.rst b/docs/api_ref/tests/exceptions_tests.rst new file mode 100644 index 0000000..c85b34f --- /dev/null +++ b/docs/api_ref/tests/exceptions_tests.rst @@ -0,0 +1,7 @@ +tests.exceptions_tests module +============================== + +.. automodule:: tests.exceptions_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/family_tests.rst b/docs/api_ref/tests/family_tests.rst index 1945aa2..2c1744c 100644 --- a/docs/api_ref/tests/family_tests.rst +++ b/docs/api_ref/tests/family_tests.rst @@ -1,13 +1,7 @@ -============ -family_tests -============ - Tests in ``tests.family_tests``: +tests.family_tests module +==========================
---------------- -Available tests ---------------- - .. autoclass:: tests.family_tests.TestFamily - :members: - .. autoclass:: tests.family_tests.TestOldFamilyMethod - :members: - +.. automodule:: tests.family_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/file_tests.rst b/docs/api_ref/tests/file_tests.rst index 5f1a712..90a3be0 100644 --- a/docs/api_ref/tests/file_tests.rst +++ b/docs/api_ref/tests/file_tests.rst @@ -1,11 +1,7 @@ -========== -file_tests -========== - Tests in ``tests.file_tests``: +tests.file_tests module +========================
---------------- -Available tests ---------------- - .. autoclass:: tests.file_tests.TestShareFiles - :members: - +.. automodule:: tests.file_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/fixes_tests.rst b/docs/api_ref/tests/fixes_tests.rst new file mode 100644 index 0000000..39b0acb --- /dev/null +++ b/docs/api_ref/tests/fixes_tests.rst @@ -0,0 +1,7 @@ +tests.fixes_tests module +========================= + +.. automodule:: tests.fixes_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/flow_edit_tests.rst b/docs/api_ref/tests/flow_edit_tests.rst index c81ed1c..2e379fd 100644 --- a/docs/api_ref/tests/flow_edit_tests.rst +++ b/docs/api_ref/tests/flow_edit_tests.rst @@ -1,16 +1,7 @@ -=============== -flow_edit_tests -=============== - Tests in ``tests.flow_edit_tests``: +tests.flow_edit_tests module +==============================
---------------- -Available tests ---------------- - .. autoclass:: tests.flow_edit_tests.TestFlowCreateTopic - :members: - .. autoclass:: tests.flow_edit_tests.TestFlowReply - :members: - .. autoclass:: tests.flow_edit_tests.TestFlowLockTopic - :members: - .. autoclass:: tests.flow_edit_tests.TestFlowEditFailure - :members: +.. automodule:: tests.flow_edit_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/flow_tests.rst b/docs/api_ref/tests/flow_tests.rst index 124e266..a85eca1 100644 --- a/docs/api_ref/tests/flow_tests.rst +++ b/docs/api_ref/tests/flow_tests.rst @@ -1,18 +1,7 @@ -========== -flow_tests -========== - Tests in ``tests.flow_tests``: +tests.flow_tests module +========================
---------------- -Available tests ---------------- - .. autoclass:: tests.flow_tests.TestBoardBasePageMethods - :members: - .. autoclass:: tests.flow_tests.TestTopicBasePageMethods - :members: - .. autoclass:: tests.flow_tests.TestLoadRevisionsCaching - :members: - .. autoclass:: tests.flow_tests.TestFlowLoading - :members: - .. autoclass:: tests.flow_tests.TestFlowFactoryErrors - :members: +.. automodule:: tests.flow_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/flow_thanks_tests.rst b/docs/api_ref/tests/flow_thanks_tests.rst new file mode 100644 index 0000000..6d81159 --- /dev/null +++ b/docs/api_ref/tests/flow_thanks_tests.rst @@ -0,0 +1,7 @@ +tests.flow_thanks_tests module +================================ + +.. automodule:: tests.flow_thanks_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/http_tests.rst b/docs/api_ref/tests/http_tests.rst index d9dcf28..bf60a3a 100644 --- a/docs/api_ref/tests/http_tests.rst +++ b/docs/api_ref/tests/http_tests.rst @@ -1,17 +1,7 @@ -========== -http_tests -========== - Tests in ``tests.http_tests``: +tests.http_tests module +========================
---------------- -Available tests ---------------- - .. autoclass:: tests.http_tests.DefaultUserAgentTestCase - :members: - .. autoclass:: tests.http_tests.HttpTestCase - :members: - .. autoclass:: tests.http_tests.TestGetAuthenticationConfig - :members: - .. autoclass:: tests.http_tests.UserAgentTestCase - :members: - +.. automodule:: tests.http_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/i18n.pywikibot.rst b/docs/api_ref/tests/i18n.pywikibot.rst new file mode 100644 index 0000000..690a45f --- /dev/null +++ b/docs/api_ref/tests/i18n.pywikibot.rst @@ -0,0 +1,7 @@ +tests.i18n.pywikibot module +=========================== + +.. automodule:: tests.i18n.pywikibot + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/i18n.rst b/docs/api_ref/tests/i18n.rst new file mode 100644 index 0000000..9d620ed --- /dev/null +++ b/docs/api_ref/tests/i18n.rst @@ -0,0 +1,15 @@ +tests.i18n package +================== + +.. automodule:: tests.i18n + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + i18n.pywikibot + diff --git a/docs/api_ref/tests/i18n_tests.rst b/docs/api_ref/tests/i18n_tests.rst index 805aca1..e59ef1b 100644 --- a/docs/api_ref/tests/i18n_tests.rst +++ b/docs/api_ref/tests/i18n_tests.rst @@ -1,15 +1,7 @@ -========== -i18n_tests -========== - Tests in ``tests.i18n_tests``: +tests.i18n_tests module +========================
---------------- -Available tests ---------------- - .. autoclass:: tests.i18n_tests.TestTWNTranslate - :members: - .. autoclass:: tests.i18n_tests.TestTWTranslate - :members: - .. autoclass:: tests.i18n_tests.TestTranslate - :members: - +.. automodule:: tests.i18n_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/imagecopy_tests.rst b/docs/api_ref/tests/imagecopy_tests.rst new file mode 100644 index 0000000..c977e2b --- /dev/null +++ b/docs/api_ref/tests/imagecopy_tests.rst @@ -0,0 +1,7 @@ +tests.imagecopy_tests module +============================= + +.. automodule:: tests.imagecopy_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/index.rst b/docs/api_ref/tests/index.rst index 92957b4..c4cd995 100644 --- a/docs/api_ref/tests/index.rst +++ b/docs/api_ref/tests/index.rst @@ -7,38 +7,70 @@ .. toctree:: :maxdepth: 1
- deprecation<./deprecation_tests> - thread<./thread_tests> + api<./api_tests> + aspects + basepage<./basepage_tests> + bot<./bot_tests> + cache<./cache_tests> + category<./category_tests> + conftest + cosmetic_changes<./cosmetic_changes_tests> date<./date_tests> - mediawikiversion<./mediawikiversion_tests> - tools_chars<./tools_chars_tests> - tools_ip<./tools_ip_tests> - xmlreader<./xmlreader_tests> - textlib<./textlib_tests> - http<./http_tests> - namespace<./namespace_tests> + deprecation<./deprecation_tests> + diff<./diff_tests> + djvu<./djvu_tests> dry_api<./dry_api_tests> dry_site<./dry_site_tests> - api<./api_tests> - family<./family_tests> - site<./site_tests> - link<./link_tests> - interwiki_link<./interwiki_link_tests> - page<./page_tests> - file<./file_tests> edit_failure<./edit_failure_tests> - timestripper<./timestripper_tests> - pagegenerators<./pagegenerators_tests> - weblib<./weblib_tests> - i18n<./i18n_tests> - wikistats<./wikistats_tests> - ui<./ui_tests> - wikibase<./wikibase_tests> - wikibase_edit<./wikibase_edit_tests> - upload<./upload_tests> - oauth<./oauth_tests> - flow<./flow_tests> + edit<./edit_tests> + eventstreams<./eventstreams_tests> + exceptions<./exceptions_tests> + family<./family_tests> + file<./file_tests> + fixes<./fixes_tests> flow_edit<./flow_edit_tests> + flow<./flow_tests> + flow_thanks<./flow_thanks_tests> + http<./http_tests> + i18n<./i18n_tests> + interwiki_graph<./interwiki_graph_tests> + interwiki_link<./interwiki_link_tests> + l10n<./l10n_tests> + link<./link_tests> + logentry<./logentry_tests> + login<./login_tests> + mediawikiversion<./mediawikiversion_tests> + namespace<./namespace_tests> + oauth<./oauth_tests> + page<./page_tests> + pagegenerators<./pagegenerators_tests> + paraminfo<./paraminfo_tests> + plural<./plural_tests> + proofreadpage<./proofreadpage_tests> + python<./python_tests> + site_detect<./site_detect_tests> + site<./site_tests> + sparql<./sparql_tests> + tests<./tests_tests> + textlib<./textlib_tests> + thanks<./thanks_tests> + thread<./thread_tests> + timestamp<./timestamp_tests> + timestripper<./timestripper_tests> + tk<./tk_tests> + tools_chars<./tools_chars_tests> + tools_formatter<./tools_formatter_tests> + tools_ip<./tools_ip_tests> + tools<./tools_tests> + ui_options<./ui_options_tests> + ui<./ui_tests> + user<./user_tests> + utils + weblib<./weblib_tests> + wikibase_edit<./wikibase_edit_tests> + wikibase<./wikibase_tests> + wikistats<./wikistats_tests> + xmlreader<./xmlreader_tests>
============ Script tests @@ -49,7 +81,24 @@ .. toctree:: :maxdepth: 1
+ add_text<./add_text_tests> + archivebot<./archivebot_tests> + category_bot<./category_bot_tests> + checkimages<./checkimages_tests> + data_ingestion<./data_ingestion_tests> + deletionbot<./deletionbot_tests> + disambredir<./disambredir_tests> + imagecopy<./imagecopy_tests> + interwikidata<./interwikidata_tests> + isbn<./isbn_tests> + patrolbot<./patrolbot_tests> + protectbot<./protectbot_tests> pwb<./pwb_tests> script<./script_tests> - archivebot<./archivebot_tests> - data_ingestion<./data_ingestion_tests> + redirect_bot<./redirect_bot_tests> + reflinks<./reflinks_tests> + replacebot<./replacebot_tests> + template_bot<./template_bot_tests> + upload<./upload_tests> + uploadbot<./uploadbot_tests> + weblinkchecker<./weblinkchecker_tests> diff --git a/docs/api_ref/tests/interwiki_graph_tests.rst b/docs/api_ref/tests/interwiki_graph_tests.rst new file mode 100644 index 0000000..b157a34 --- /dev/null +++ b/docs/api_ref/tests/interwiki_graph_tests.rst @@ -0,0 +1,7 @@ +tests.interwiki_graph_tests module +==================================== + +.. automodule:: tests.interwiki_graph_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/interwiki_link_tests.rst b/docs/api_ref/tests/interwiki_link_tests.rst index 667ee4e..049a678 100644 --- a/docs/api_ref/tests/interwiki_link_tests.rst +++ b/docs/api_ref/tests/interwiki_link_tests.rst @@ -1,13 +1,7 @@ -==================== -interwiki_link_tests -==================== - Tests in ``tests.interwiki_link_tests``: +tests.interwiki_link_tests module +===================================
---------------- -Available tests ---------------- - .. autoclass:: tests.interwiki_link_tests.TestInterwikiLinksToNonLocalSites - :members: - .. autoclass:: tests.interwiki_link_tests.TestPartiallyQualifiedLinkDifferentCodeParser - :members: - +.. automodule:: tests.interwiki_link_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/interwikidata_tests.rst b/docs/api_ref/tests/interwikidata_tests.rst new file mode 100644 index 0000000..966cd80 --- /dev/null +++ b/docs/api_ref/tests/interwikidata_tests.rst @@ -0,0 +1,7 @@ +tests.interwikidata_tests module +================================= + +.. automodule:: tests.interwikidata_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/isbn_tests.rst b/docs/api_ref/tests/isbn_tests.rst new file mode 100644 index 0000000..a132ab8 --- /dev/null +++ b/docs/api_ref/tests/isbn_tests.rst @@ -0,0 +1,7 @@ +tests.isbn_tests module +======================== + +.. automodule:: tests.isbn_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/l10n_tests.rst b/docs/api_ref/tests/l10n_tests.rst new file mode 100644 index 0000000..e64666c --- /dev/null +++ b/docs/api_ref/tests/l10n_tests.rst @@ -0,0 +1,7 @@ +tests.l10n_tests module +======================== + +.. automodule:: tests.l10n_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/link_tests.rst b/docs/api_ref/tests/link_tests.rst index 6b72b20..26882b6 100644 --- a/docs/api_ref/tests/link_tests.rst +++ b/docs/api_ref/tests/link_tests.rst @@ -1,49 +1,7 @@ -========== -link_tests -========== - Tests in ``tests.link_tests``: +tests.link_tests module +========================
---------------- -Available tests ---------------- - .. autoclass:: tests.link_tests.TestEmptyTitle - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedExplicitLinkDifferentFamilyParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedExplicitLinkNoLangConfigFamilyParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedExplicitLinkSameFamilyParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedImplicitLinkDifferentFamilyParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedImplicitLinkNoLangConfigFamilyParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedImplicitLinkSameFamilyParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedNoLangFamilyExplicitLinkParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedNoLangFamilyImplicitLinkParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedOneSiteFamilyExplicitLinkParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedOneSiteFamilyImplicitLinkParser - :members: - .. autoclass:: tests.link_tests.TestFullyQualifiedSameNamespaceFamilyParser - :members: - .. autoclass:: tests.link_tests.TestInvalidInterwikiLinks - :members: - .. autoclass:: tests.link_tests.TestLink - :members: - .. autoclass:: tests.link_tests.TestPartiallyQualifiedExplicitLinkDifferentCodeParser - :members: - .. autoclass:: tests.link_tests.TestPartiallyQualifiedExplicitLinkDifferentFamilyParser - :members: - .. autoclass:: tests.link_tests.TestPartiallyQualifiedExplicitLinkSameSiteParser - :members: - .. autoclass:: tests.link_tests.TestPartiallyQualifiedImplicitLinkDifferentCodeParser - :members: - .. autoclass:: tests.link_tests.TestPartiallyQualifiedImplicitLinkDifferentFamilyParser - :members: - .. autoclass:: tests.link_tests.TestPartiallyQualifiedImplicitLinkSameSiteParser - :members: - +.. automodule:: tests.link_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/logentry_tests.rst b/docs/api_ref/tests/logentry_tests.rst new file mode 100644 index 0000000..dc008f1 --- /dev/null +++ b/docs/api_ref/tests/logentry_tests.rst @@ -0,0 +1,7 @@ +tests.logentry_tests module +============================ + +.. automodule:: tests.logentry_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/login_tests.rst b/docs/api_ref/tests/login_tests.rst new file mode 100644 index 0000000..0ca13be --- /dev/null +++ b/docs/api_ref/tests/login_tests.rst @@ -0,0 +1,7 @@ +tests.login_tests module +========================= + +.. automodule:: tests.login_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/mediawikiversion_tests.rst b/docs/api_ref/tests/mediawikiversion_tests.rst index 61de676..a57e51c 100644 --- a/docs/api_ref/tests/mediawikiversion_tests.rst +++ b/docs/api_ref/tests/mediawikiversion_tests.rst @@ -1,11 +1,7 @@ -====================== -mediawikiversion_tests -====================== - Tests in ``tests.mediawikiversion_tests``: +tests.mediawikiversion_tests module +====================================
---------------- -Available tests ---------------- - .. autoclass:: tests.mediawikiversion_tests.TestMediaWikiVersion - :members: - +.. automodule:: tests.mediawikiversion_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/namespace_tests.rst b/docs/api_ref/tests/namespace_tests.rst index 6b8f291..984b56b 100644 --- a/docs/api_ref/tests/namespace_tests.rst +++ b/docs/api_ref/tests/namespace_tests.rst @@ -1,11 +1,7 @@ -=============== -namespace_tests -=============== - Tests in ``tests.namespace_tests``: +tests.namespace_tests module +=============================
---------------- -Available tests ---------------- - .. autoclass:: tests.namespace_tests.TestNamespaceObject - :members: - +.. automodule:: tests.namespace_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/oauth_tests.rst b/docs/api_ref/tests/oauth_tests.rst index ec46db6..778492b 100644 --- a/docs/api_ref/tests/oauth_tests.rst +++ b/docs/api_ref/tests/oauth_tests.rst @@ -1,11 +1,7 @@ -=========== -oauth_tests -=========== - Tests in ``tests.oauth_tests``: +tests.oauth_tests module +=========================
---------------- -Available tests ---------------- - .. autoclass:: tests.oauth_tests.TestOauthLoginManger - :members: - +.. automodule:: tests.oauth_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/page_tests.rst b/docs/api_ref/tests/page_tests.rst index 3a18cca..10abeb1 100644 --- a/docs/api_ref/tests/page_tests.rst +++ b/docs/api_ref/tests/page_tests.rst @@ -1,32 +1,7 @@ -========== -page_tests -========== - Tests in ``tests.page_tests``: +tests.page_tests module +========================
---------------- -Available tests ---------------- - .. autoclass:: tests.page_tests.TestLinkObject - :members: - .. autoclass:: tests.page_tests.TestPageObjectEnglish - :members: - .. autoclass:: tests.page_tests.TestPageObject - :members: - .. autoclass:: tests.page_tests.TestPageObjectEnglish - :members: - .. autoclass:: tests.page_tests.TestPageRepr - :members: - .. autoclass:: tests.page_tests.TestPageBotMayEdit - :members: - .. autoclass:: tests.page_tests.TestPageHistory - :members: - .. autoclass:: tests.page_tests.TestPageRedirects - :members: - .. autoclass:: tests.page_tests.TestPageUserAction - :members: - .. autoclass:: tests.page_tests.TestPageDelete - :members: - .. autoclass:: tests.page_tests.TestPageProtect - :members: - .. autoclass:: tests.page_tests.HtmlEntity - :members: +.. automodule:: tests.page_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/pagegenerators_tests.rst b/docs/api_ref/tests/pagegenerators_tests.rst index 52f121f..79695b9 100644 --- a/docs/api_ref/tests/pagegenerators_tests.rst +++ b/docs/api_ref/tests/pagegenerators_tests.rst @@ -1,27 +1,7 @@ -==================== -pagegenerators_tests -==================== - Tests in ``tests.pagegenerators_tests``: +tests.pagegenerators_tests module +==================================
---------------- -Available tests ---------------- - .. autoclass:: tests.pagegenerators_tests.TestDryPageGenerators - :members: - .. autoclass:: tests.pagegenerators_tests.EdittimeFilterPageGeneratorTestCase - :members: - .. autoclass:: tests.pagegenerators_tests.TestRepeatingGenerator - :members: - .. autoclass:: tests.pagegenerators_tests.TestPreloadingGenerator - :members: - .. autoclass:: tests.pagegenerators_tests.TestDequePreloadingGenerator - :members: - .. autoclass:: tests.pagegenerators_tests.TestPreloadingItemGenerator - :members: - .. autoclass:: tests.pagegenerators_tests.TestFactoryGenerator - :members: - .. autoclass:: tests.pagegenerators_tests.PageGeneratorIntersectTestCase - :members: - .. autoclass:: tests.pagegenerators_tests.EnWikipediaPageGeneratorIntersectTestCase - :members: - +.. automodule:: tests.pagegenerators_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/paraminfo_tests.rst b/docs/api_ref/tests/paraminfo_tests.rst new file mode 100644 index 0000000..166c3cb --- /dev/null +++ b/docs/api_ref/tests/paraminfo_tests.rst @@ -0,0 +1,7 @@ +tests.paraminfo_tests module +============================= + +.. automodule:: tests.paraminfo_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/patrolbot_tests.rst b/docs/api_ref/tests/patrolbot_tests.rst new file mode 100644 index 0000000..2470c24 --- /dev/null +++ b/docs/api_ref/tests/patrolbot_tests.rst @@ -0,0 +1,7 @@ +tests.patrolbot_tests module +============================= + +.. automodule:: tests.patrolbot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/plural_tests.rst b/docs/api_ref/tests/plural_tests.rst new file mode 100644 index 0000000..c301f40 --- /dev/null +++ b/docs/api_ref/tests/plural_tests.rst @@ -0,0 +1,7 @@ +tests.plural_tests module +========================== + +.. automodule:: tests.plural_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/proofreadpage_tests.rst b/docs/api_ref/tests/proofreadpage_tests.rst new file mode 100644 index 0000000..2de166d --- /dev/null +++ b/docs/api_ref/tests/proofreadpage_tests.rst @@ -0,0 +1,7 @@ +tests.proofreadpage_tests module +================================= + +.. automodule:: tests.proofreadpage_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/protectbot_tests.rst b/docs/api_ref/tests/protectbot_tests.rst new file mode 100644 index 0000000..b068332 --- /dev/null +++ b/docs/api_ref/tests/protectbot_tests.rst @@ -0,0 +1,7 @@ +tests.protectbot_tests module +============================== + +.. automodule:: tests.protectbot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/pwb.print_env.rst b/docs/api_ref/tests/pwb.print_env.rst new file mode 100644 index 0000000..ee2c293 --- /dev/null +++ b/docs/api_ref/tests/pwb.print_env.rst @@ -0,0 +1,7 @@ +tests.pwb.print_env module +=========================== + +.. automodule:: tests.pwb.print_env + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/pwb.print_locals.rst b/docs/api_ref/tests/pwb.print_locals.rst new file mode 100644 index 0000000..afd5aee --- /dev/null +++ b/docs/api_ref/tests/pwb.print_locals.rst @@ -0,0 +1,7 @@ +tests.pwb.print_locals module +============================== + +.. automodule:: tests.pwb.print_locals + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/pwb.print_unicode.rst b/docs/api_ref/tests/pwb.print_unicode.rst new file mode 100644 index 0000000..143e84d --- /dev/null +++ b/docs/api_ref/tests/pwb.print_unicode.rst @@ -0,0 +1,7 @@ +tests.pwb.print_unicode module +=============================== + +.. automodule:: tests.pwb.print_unicode + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/pwb.rst b/docs/api_ref/tests/pwb.rst new file mode 100644 index 0000000..4369026 --- /dev/null +++ b/docs/api_ref/tests/pwb.rst @@ -0,0 +1,17 @@ +tests.pwb package +================= + +.. automodule:: tests.pwb + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + pwb.print_env + pwb.print_locals + pwb.print_unicode + diff --git a/docs/api_ref/tests/pwb_tests.rst b/docs/api_ref/tests/pwb_tests.rst index 9fbefc1..1b9e606 100644 --- a/docs/api_ref/tests/pwb_tests.rst +++ b/docs/api_ref/tests/pwb_tests.rst @@ -1,11 +1,7 @@ -========= -pwb_tests -========= - Tests in ``tests.pwb_tests``: +tests.pwb_tests module +=======================
---------------- -Available tests ---------------- - .. autoclass:: tests.pwb_tests.TestPwb - :members: - +.. automodule:: tests.pwb_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/python_tests.rst b/docs/api_ref/tests/python_tests.rst new file mode 100644 index 0000000..e91ca8e --- /dev/null +++ b/docs/api_ref/tests/python_tests.rst @@ -0,0 +1,7 @@ +tests.python_tests module +========================== + +.. automodule:: tests.python_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/redirect_bot_tests.rst b/docs/api_ref/tests/redirect_bot_tests.rst new file mode 100644 index 0000000..be93cd3 --- /dev/null +++ b/docs/api_ref/tests/redirect_bot_tests.rst @@ -0,0 +1,7 @@ +tests.redirect_bot_tests module +================================= + +.. automodule:: tests.redirect_bot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/reflinks_tests.rst b/docs/api_ref/tests/reflinks_tests.rst new file mode 100644 index 0000000..2286383 --- /dev/null +++ b/docs/api_ref/tests/reflinks_tests.rst @@ -0,0 +1,7 @@ +tests.reflinks_tests module +============================ + +.. automodule:: tests.reflinks_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/replacebot_tests.rst b/docs/api_ref/tests/replacebot_tests.rst new file mode 100644 index 0000000..74cb8b3 --- /dev/null +++ b/docs/api_ref/tests/replacebot_tests.rst @@ -0,0 +1,7 @@ +tests.replacebot_tests module +============================== + +.. automodule:: tests.replacebot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/script_tests.rst b/docs/api_ref/tests/script_tests.rst index 44a9ecd..8ed9142 100644 --- a/docs/api_ref/tests/script_tests.rst +++ b/docs/api_ref/tests/script_tests.rst @@ -1,14 +1,7 @@ -============ -script_tests -============ - Tests in ``tests.script_tests``: +tests.script_tests module +==========================
---------------- -Available tests ---------------- - .. autoclass:: tests.script_tests.TestScriptHelp - :members: - .. autoclass:: tests.script_tests.TestScriptSimulate - :members: - .. autofunction:: tests.script_tests.load_tests - +.. automodule:: tests.script_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/site_detect_tests.rst b/docs/api_ref/tests/site_detect_tests.rst new file mode 100644 index 0000000..8c6036a --- /dev/null +++ b/docs/api_ref/tests/site_detect_tests.rst @@ -0,0 +1,7 @@ +tests.site_detect_tests module +================================ + +.. automodule:: tests.site_detect_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/site_tests.rst b/docs/api_ref/tests/site_tests.rst index 412f51f..4de126b 100644 --- a/docs/api_ref/tests/site_tests.rst +++ b/docs/api_ref/tests/site_tests.rst @@ -1,53 +1,7 @@ -========== -site_tests -========== - Tests in ``tests.site_tests``: +tests.site_tests module +========================
---------------- -Available tests ---------------- - .. autoclass:: tests.site_tests.SiteRandomTestCase - :members: - .. autoclass:: tests.site_tests.SiteSysopTestCase - :members: - .. autoclass:: tests.site_tests.SiteUserTestCase - :members: - .. autoclass:: tests.site_tests.TestUsernameInUsers - :members: - .. autoclass:: tests.site_tests.TestUserList - :members: - .. autoclass:: tests.site_tests.PatrolTestCase - :members: - .. autoclass:: tests.site_tests.TestDeprecatedEditTokenFunctions - :members: - .. autoclass:: tests.site_tests.TestDeprecatedPatrolToken - :members: - .. autoclass:: tests.site_tests.TestCommonsSite - :members: - .. autoclass:: tests.site_tests.TestDataSiteClientPreloading - :members: - .. autoclass:: tests.site_tests.TestDataSitePreloading - :members: - .. autoclass:: tests.site_tests.TestImageUsage - :members: - .. autoclass:: tests.site_tests.TestNonEnglishWikipediaSite - :members: - .. autoclass:: tests.site_tests.TestSiteAPILimits - :members: - .. autoclass:: tests.site_tests.TestSiteExtensions - :members: - .. autoclass:: tests.site_tests.TestSiteInfo - :members: - .. autoclass:: tests.site_tests.TestSiteLoadRevisions - :members: - .. autoclass:: tests.site_tests.TestSiteLoadRevisionsSysop - :members: - .. autoclass:: tests.site_tests.TestSiteObject - :members: - .. autoclass:: tests.site_tests.TestSiteObjectDeprecatedFunctions - :members: - .. autoclass:: tests.site_tests.TestSiteTokens - :members: - .. autoclass:: tests.site_tests.TestWiktionarySite - :members: - +.. automodule:: tests.site_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/sparql_tests.rst b/docs/api_ref/tests/sparql_tests.rst new file mode 100644 index 0000000..0b67014 --- /dev/null +++ b/docs/api_ref/tests/sparql_tests.rst @@ -0,0 +1,7 @@ +tests.sparql_tests module +========================== + +.. automodule:: tests.sparql_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/template_bot_tests.rst b/docs/api_ref/tests/template_bot_tests.rst new file mode 100644 index 0000000..4341656 --- /dev/null +++ b/docs/api_ref/tests/template_bot_tests.rst @@ -0,0 +1,7 @@ +tests.template_bot_tests module +================================= + +.. automodule:: tests.template_bot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/tests.rst b/docs/api_ref/tests/tests.rst new file mode 100644 index 0000000..d0017fb --- /dev/null +++ b/docs/api_ref/tests/tests.rst @@ -0,0 +1,107 @@ +tests package +============= + +.. automodule:: tests + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + i18n + pwb + +Submodules +---------- + +.. toctree:: + + add_text_tests + api_tests + archivebot_tests + aspects + basepage_tests + bot_tests + cache_tests + category_bot_tests + category_tests + checkimages_tests + conftest + cosmetic_changes_tests + data_ingestion_tests + date_tests + deletionbot_tests + deprecation_tests + diff_tests + disambredir_tests + djvu_tests + dry_api_tests + dry_site_tests + edit_failure_tests + edit_tests + eventstreams_tests + exceptions_tests + family_tests + file_tests + fixes_tests + flow_edit_tests + flow_tests + flow_thanks_tests + http_tests + i18n_tests + imagecopy_tests + interwiki_graph_tests + interwiki_link_tests + interwikidata_tests + isbn_tests + l10n_tests + link_tests + logentry_tests + login_tests + mediawikiversion_tests + namespace_tests + oauth_tests + page_tests + pagegenerators_tests + paraminfo_tests + patrolbot_tests + plural_tests + proofreadpage_tests + protectbot_tests + pwb_tests + python_tests + redirect_bot_tests + reflinks_tests + replacebot_tests + script_tests + site_detect_tests + site_tests + sparql_tests + template_bot_tests + tests_tests + textlib_tests + thanks_tests + thread_tests + timestamp_tests + timestripper_tests + tk_tests + tools_chars_tests + tools_formatter_tests + tools_ip_tests + tools_tests + ui_options_tests + ui_tests + upload_tests + uploadbot_tests + user_tests + utils + weblib_tests + weblinkchecker_tests + wikibase_edit_tests + wikibase_tests + wikistats_tests + xmlreader_tests + diff --git a/docs/api_ref/tests/tests_tests.rst b/docs/api_ref/tests/tests_tests.rst new file mode 100644 index 0000000..717d90d --- /dev/null +++ b/docs/api_ref/tests/tests_tests.rst @@ -0,0 +1,7 @@ +tests.tests_tests module +========================= + +.. automodule:: tests.tests_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/textlib_tests.rst b/docs/api_ref/tests/textlib_tests.rst index 8a4a991..595996f 100644 --- a/docs/api_ref/tests/textlib_tests.rst +++ b/docs/api_ref/tests/textlib_tests.rst @@ -1,21 +1,7 @@ -============= -textlib_tests -============= - Tests in ``tests.textlib_tests``: +tests.textlib_tests module +===========================
---------------- -Available tests ---------------- - .. autoclass:: tests.textlib_tests.TestCategoryRearrangement - :members: - .. autoclass:: tests.textlib_tests.TestFormatCategory - :members: - .. autoclass:: tests.textlib_tests.TestFormatInterwiki - :members: - .. autoclass:: tests.textlib_tests.TestLocalDigits - :members: - .. autoclass:: tests.textlib_tests.TestSectionFunctions - :members: - .. autoclass:: tests.textlib_tests.TestTemplatesInCategory - :members: - +.. automodule:: tests.textlib_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/thanks_tests.rst b/docs/api_ref/tests/thanks_tests.rst new file mode 100644 index 0000000..93235b3 --- /dev/null +++ b/docs/api_ref/tests/thanks_tests.rst @@ -0,0 +1,7 @@ +tests.thanks_tests module +========================== + +.. automodule:: tests.thanks_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/thread_tests.rst b/docs/api_ref/tests/thread_tests.rst index 2656cd1..578acc7 100644 --- a/docs/api_ref/tests/thread_tests.rst +++ b/docs/api_ref/tests/thread_tests.rst @@ -1,15 +1,7 @@ -============ -thread_tests -============ - Tests in ``tests.thread_tests``: +tests.thread_tests module +==========================
---------------- -Available tests ---------------- - .. autoclass:: tests.thread_tests.BasicThreadedGeneratorTestCase - :members: - .. autoclass:: tests.thread_tests.GeneratorIntersectTestCase - :members: - .. autoclass:: tests.thread_tests.BasicGeneratorIntersectTestCase - :members: - +.. automodule:: tests.thread_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/timestamp_tests.rst b/docs/api_ref/tests/timestamp_tests.rst new file mode 100644 index 0000000..1620a09 --- /dev/null +++ b/docs/api_ref/tests/timestamp_tests.rst @@ -0,0 +1,7 @@ +tests.timestamp_tests module +============================= + +.. automodule:: tests.timestamp_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/timestripper_tests.rst b/docs/api_ref/tests/timestripper_tests.rst index 49f9070..d829fe5 100644 --- a/docs/api_ref/tests/timestripper_tests.rst +++ b/docs/api_ref/tests/timestripper_tests.rst @@ -1,13 +1,7 @@ -================== -timestripper_tests -================== - Tests in ``tests.timestripper_tests``: +tests.timestripper_tests module +================================
---------------- -Available tests ---------------- - .. autoclass:: tests.timestripper_tests.TestTimeStripperWithDigitsAsMonths - :members: - .. autoclass:: tests.timestripper_tests.TestTimeStripperWithNoDigitsAsMonths - :members: - +.. automodule:: tests.timestripper_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/tk_tests.rst b/docs/api_ref/tests/tk_tests.rst new file mode 100644 index 0000000..08d5e77 --- /dev/null +++ b/docs/api_ref/tests/tk_tests.rst @@ -0,0 +1,7 @@ +tests.tk_tests module +====================== + +.. automodule:: tests.tk_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/tools_chars_tests.rst b/docs/api_ref/tests/tools_chars_tests.rst index 2db68c2..b538f4e 100644 --- a/docs/api_ref/tests/tools_chars_tests.rst +++ b/docs/api_ref/tests/tools_chars_tests.rst @@ -1,10 +1,7 @@ -================= -tools_chars_tests -================= - Tests in ``tests.tools_chars_tests``: +tests.tools_chars_tests module +================================
---------------- -Available tests ---------------- - .. autoclass:: tests.tools_chars_tests.CharsTestCase - :members: +.. automodule:: tests.tools_chars_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/tools_formatter_tests.rst b/docs/api_ref/tests/tools_formatter_tests.rst new file mode 100644 index 0000000..93c7693 --- /dev/null +++ b/docs/api_ref/tests/tools_formatter_tests.rst @@ -0,0 +1,7 @@ +tests.tools_formatter_tests module +==================================== + +.. automodule:: tests.tools_formatter_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/tools_ip_tests.rst b/docs/api_ref/tests/tools_ip_tests.rst index ccd7a7b..8a71ca2 100644 --- a/docs/api_ref/tests/tools_ip_tests.rst +++ b/docs/api_ref/tests/tools_ip_tests.rst @@ -1,12 +1,7 @@ -============== -tools_ip_tests -============== - Tests in ``tests.tools_ip_tests``: +tests.tools_ip_tests module +=============================
---------------- -Available tests ---------------- - .. autoclass:: tests.tools_ip_tests.IPRegexTestCase - :members: - .. autoclass:: tests.tools_ip_tests.IPAddressModuleTestCase - :members: +.. automodule:: tests.tools_ip_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/tools_tests.rst b/docs/api_ref/tests/tools_tests.rst new file mode 100644 index 0000000..38069f0 --- /dev/null +++ b/docs/api_ref/tests/tools_tests.rst @@ -0,0 +1,7 @@ +tests.tools_tests module +========================= + +.. automodule:: tests.tools_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/ui_options_tests.rst b/docs/api_ref/tests/ui_options_tests.rst new file mode 100644 index 0000000..2c44676 --- /dev/null +++ b/docs/api_ref/tests/ui_options_tests.rst @@ -0,0 +1,7 @@ +tests.ui_options_tests module +=============================== + +.. automodule:: tests.ui_options_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/ui_tests.rst b/docs/api_ref/tests/ui_tests.rst index af67ec7..0d685e4 100644 --- a/docs/api_ref/tests/ui_tests.rst +++ b/docs/api_ref/tests/ui_tests.rst @@ -1,22 +1,7 @@ -======== -ui_tests -======== - Tests in ``tests.ui_tests``: +tests.ui_tests module +======================
---------------- -Available tests ---------------- - .. autoclass:: tests.ui_tests.TestTerminalOutput - :members: - .. autoclass:: tests.ui_tests.TestTerminalInput - :members: - .. autoclass:: tests.ui_tests.TestTerminalOutputColorUnix - :members: - .. autoclass:: tests.ui_tests.TestTerminalUnicodeUnix - :members: - .. autoclass:: tests.ui_tests.TestTransliterationUnix - :members: - .. autoclass:: tests.ui_tests.TestWindowsTerminalUnicode - :members: - .. autoclass:: tests.ui_tests.TestWindowsTerminalUnicodeArguments - :members: +.. automodule:: tests.ui_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/upload_tests.rst b/docs/api_ref/tests/upload_tests.rst index 52f52a3..34dbe64 100644 --- a/docs/api_ref/tests/upload_tests.rst +++ b/docs/api_ref/tests/upload_tests.rst @@ -1,11 +1,7 @@ -============ -upload_tests -============ - Tests in ``tests.upload_tests``: +tests.upload_tests module +==========================
---------------- -Available tests ---------------- - .. autoclass:: tests.upload_tests.TestUpload - :members: - +.. automodule:: tests.upload_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/uploadbot_tests.rst b/docs/api_ref/tests/uploadbot_tests.rst new file mode 100644 index 0000000..10f524d --- /dev/null +++ b/docs/api_ref/tests/uploadbot_tests.rst @@ -0,0 +1,7 @@ +tests.uploadbot_tests module +============================= + +.. automodule:: tests.uploadbot_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/user_tests.rst b/docs/api_ref/tests/user_tests.rst new file mode 100644 index 0000000..e23518b --- /dev/null +++ b/docs/api_ref/tests/user_tests.rst @@ -0,0 +1,7 @@ +tests.user_tests module +======================== + +.. automodule:: tests.user_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/utils.rst b/docs/api_ref/tests/utils.rst new file mode 100644 index 0000000..21eb5b7 --- /dev/null +++ b/docs/api_ref/tests/utils.rst @@ -0,0 +1,7 @@ +tests.utils module +================== + +.. automodule:: tests.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/weblib_tests.rst b/docs/api_ref/tests/weblib_tests.rst index 761973e..80247c2 100644 --- a/docs/api_ref/tests/weblib_tests.rst +++ b/docs/api_ref/tests/weblib_tests.rst @@ -1,13 +1,7 @@ -============ -weblib_tests -============ - Tests in ``tests.weblib_tests``: +tests.weblib_tests module +==========================
---------------- -Available tests ---------------- - .. autoclass:: tests.weblib_tests.TestInternetArchive - :members: - .. autoclass:: tests.weblib_tests.TestWebCite - :members: - +.. automodule:: tests.weblib_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/weblinkchecker_tests.rst b/docs/api_ref/tests/weblinkchecker_tests.rst new file mode 100644 index 0000000..fb546e9 --- /dev/null +++ b/docs/api_ref/tests/weblinkchecker_tests.rst @@ -0,0 +1,7 @@ +tests.weblinkchecker_tests module +================================== + +.. automodule:: tests.weblinkchecker_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/wikibase_edit_tests.rst b/docs/api_ref/tests/wikibase_edit_tests.rst index d9b7e74..b40e783 100644 --- a/docs/api_ref/tests/wikibase_edit_tests.rst +++ b/docs/api_ref/tests/wikibase_edit_tests.rst @@ -1,11 +1,7 @@ -=================== -wikibase_edit_tests -=================== - Tests in ``tests.wikibase_edit_tests``: +tests.wikibase_edit_tests module +==================================
---------------- -Available tests ---------------- - .. autoclass:: tests.wikibase_edit_tests.TestWikibaseWriteGeneral - :members: - +.. automodule:: tests.wikibase_edit_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/wikibase_tests.rst b/docs/api_ref/tests/wikibase_tests.rst index 78e7167..5d06087 100644 --- a/docs/api_ref/tests/wikibase_tests.rst +++ b/docs/api_ref/tests/wikibase_tests.rst @@ -1,45 +1,7 @@ -============== -wikibase_tests -============== - Tests in ``tests.wikibase_tests``: +tests.wikibase_tests module +============================
---------------- -Available tests ---------------- - .. autoclass:: tests.wikibase_tests.TestLoadRevisionsCaching - :members: - .. autoclass:: tests.wikibase_tests.TestAlternateNamespaces - :members: - .. autoclass:: tests.wikibase_tests.TestClaimSetValue - :members: - .. autoclass:: tests.wikibase_tests.TestGeneral - :members: - .. autoclass:: tests.wikibase_tests.TestItemLoad - :members: - .. autoclass:: tests.wikibase_tests.TestItemPageExtensibility - :members: - .. autoclass:: tests.wikibase_tests.TestJSON - :members: - .. autoclass:: tests.wikibase_tests.TestLinks - :members: - .. autoclass:: tests.wikibase_tests.TestNamespaces - :members: - .. autoclass:: tests.wikibase_tests.TestItemBasePageMethods - :members: - .. autoclass:: tests.wikibase_tests.TestPageMethodsWithItemTitle - :members: - .. autoclass:: tests.wikibase_tests.TestPreloadingItemGenerator - :members: - .. autoclass:: tests.wikibase_tests.TestPropertyPage - :members: - .. autoclass:: tests.wikibase_tests.TestRedirects - :members: - .. autoclass:: tests.wikibase_tests.TestWbTime - :members: - .. autoclass:: tests.wikibase_tests.TestWbQuantity - :members: - .. autoclass:: tests.wikibase_tests.TestWriteNormalizeData - :members: - .. autoclass:: tests.wikibase_tests.TestWriteNormalizeLang - :members: - +.. automodule:: tests.wikibase_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/wikistats_tests.rst b/docs/api_ref/tests/wikistats_tests.rst index 160d5ee..48261a2 100644 --- a/docs/api_ref/tests/wikistats_tests.rst +++ b/docs/api_ref/tests/wikistats_tests.rst @@ -1,11 +1,7 @@ -=============== -wikistats_tests -=============== - Tests in ``tests.wikistats_tests``: +tests.wikistats_tests module +=============================
---------------- -Available tests ---------------- - .. autoclass:: tests.wikistats_tests.WikiStatsTestCase - :members: - +.. automodule:: tests.wikistats_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_ref/tests/xmlreader_tests.rst b/docs/api_ref/tests/xmlreader_tests.rst index f3c24a2..7deff6e 100644 --- a/docs/api_ref/tests/xmlreader_tests.rst +++ b/docs/api_ref/tests/xmlreader_tests.rst @@ -1,11 +1,7 @@ -=============== -xmlreader_tests -=============== - Tests in ``tests.xmlreader_tests``: +tests.xmlreader_tests module +=============================
---------------- -Available tests ---------------- - .. autoclass:: tests.xmlreader_tests.XmlReaderTestCase - :members: - +.. automodule:: tests.xmlreader_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 2c140a4..c691ca3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,10 @@ 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', - 'numpydoc'] + 'sphinx.ext.napoleon'] + +# Allow lines like "Example:" to be followed by a code block +napoleon_use_admonition_for_examples = True
# Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -282,6 +285,9 @@ elif line.strip().startswith('python'): # Indent commands lines[index] = ' ' + line.strip() + if '=' in line: + # Escape equal signs + lines[index] = line.replace('=', '\=')
def pywikibot_skip_members(app, what, name, obj, skip, options): diff --git a/docs/index.rst b/docs/index.rst index 8a6cea7..c7197f2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,7 +54,7 @@ :maxdepth: 1
api_ref/tests/index - scripts.maintenance + scripts/scripts.maintenance
Miscellaneous diff --git a/docs/make.bat b/docs/make.bat index 8f12a97..8bacfe3 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -1,190 +1,36 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set I18NSPHINXOPTS=%SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^<target^>` where ^<target^> is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%*) do rmdir /q /s %%i - del /q /s %BUILDDIR%* - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Pywikibot.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Pywikibot.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -:end +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=Pywikibot + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/requirements-py3.txt b/docs/requirements-py3.txt index c64d32e..e4c7d88 100644 --- a/docs/requirements-py3.txt +++ b/docs/requirements-py3.txt @@ -4,5 +4,4 @@
sphinx sphinx-epytext>=0.0.4 -numpydoc
diff --git a/docs/scripts.maintenance.rst b/docs/scripts.maintenance.rst deleted file mode 100644 index 74a478a..0000000 --- a/docs/scripts.maintenance.rst +++ /dev/null @@ -1,43 +0,0 @@ -maintenance Package -=================== - -:mod:`maintenance` Package --------------------------- - -.. automodule:: scripts.maintenance - :members: - :undoc-members: - :show-inheritance: - -:mod:`cache` Module -------------------- - -.. automodule:: scripts.maintenance.cache - :members: - :undoc-members: - :show-inheritance: - -:mod:`compat2core` Module -------------------------- - -.. automodule:: scripts.maintenance.compat2core - :members: - :undoc-members: - :show-inheritance: - -:mod:`make_i18n_dict` Module ----------------------------- - -.. automodule:: scripts.maintenance.make_i18n_dict - :members: - :undoc-members: - :show-inheritance: - -:mod:`wikimedia_sites` Module ------------------------------ - -.. automodule:: scripts.maintenance.wikimedia_sites - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/scripts/scripts.archive.rst b/docs/scripts/scripts.archive.rst new file mode 100644 index 0000000..4cfbdbe --- /dev/null +++ b/docs/scripts/scripts.archive.rst @@ -0,0 +1,20 @@ +scripts.archive archived scripts +================================ + +.. automodule:: scripts.archive + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +scripts.archive.featured script +------------------------------- + +.. automodule:: scripts.archive.featured + :members: + :undoc-members: + :show-inheritance: + + diff --git a/docs/scripts/scripts.maintenance.rst b/docs/scripts/scripts.maintenance.rst index bcc29e0..705963e 100644 --- a/docs/scripts/scripts.maintenance.rst +++ b/docs/scripts/scripts.maintenance.rst @@ -33,18 +33,36 @@ :undoc-members: :show-inheritance:
-scripts.maintenance.make_i18n_dict script +scripts.maintenance.diff_checker script +---------------------------------------- + +.. automodule:: scripts.maintenance.diff_checker + :members: + :undoc-members: + :show-inheritance: + +scripts.maintenance.download_dump script ----------------------------------------- + +.. automodule:: scripts.maintenance.download_dump + :members: + :undoc-members: + :show-inheritance: + +scripts.maintenance.make_i18n_dict script +-------------------------------------------
.. automodule:: scripts.maintenance.make_i18n_dict :members: :undoc-members: :show-inheritance:
-scripts.maintenance.wikimedia_sites script ------------------------------------------- +scripts.maintenance.wikimedia_sites script +-------------------------------------------
.. automodule:: scripts.maintenance.wikimedia_sites :members: :undoc-members: :show-inheritance: + + diff --git a/docs/scripts/scripts.rst b/docs/scripts/scripts.rst index 4a94d72..e4931e7 100644 --- a/docs/scripts/scripts.rst +++ b/docs/scripts/scripts.rst @@ -1,5 +1,5 @@ -user scripts package -==================== +scripts package +===============
.. automodule:: scripts :members: @@ -11,14 +11,16 @@
.. toctree::
+ scripts.archive scripts.i18n scripts.maintenance + scripts.userscripts
Submodules ----------
-scripts.add_text script ------------------------ +scripts.add_text script +------------------------
.. automodule:: scripts.add_text :members: @@ -27,6 +29,11 @@
scripts.archivebot script ------------------------- + +.. automodule:: scripts.archivebot + :members: + :undoc-members: + :show-inheritance:
scripts.basic script -------------------- @@ -44,10 +51,18 @@ :undoc-members: :show-inheritance:
-scripts.capitalize_redirects script ------------------------------------ +scripts.capitalize_redirects script +------------------------------------
.. automodule:: scripts.capitalize_redirects + :members: + :undoc-members: + :show-inheritance: + +scripts.casechecker script +-------------------------- + +.. automodule:: scripts.casechecker :members: :undoc-members: :show-inheritance: @@ -64,6 +79,14 @@ -----------------------
.. automodule:: scripts.category + :members: + :undoc-members: + :show-inheritance: + +scripts.category_redirect script +--------------------------------- + +.. automodule:: scripts.category_redirect :members: :undoc-members: :show-inheritance: @@ -92,16 +115,16 @@ :undoc-members: :show-inheritance:
-scripts.clean_sandbox script ----------------------------- +scripts.clean_sandbox script +-----------------------------
.. automodule:: scripts.clean_sandbox :members: :undoc-members: :show-inheritance:
-scripts.commons_link script ---------------------------- +scripts.commons_link script +----------------------------
.. automodule:: scripts.commons_link :members: @@ -116,32 +139,32 @@ :undoc-members: :show-inheritance:
-scripts.coordinate_import script --------------------------------- +scripts.coordinate_import script +---------------------------------
.. automodule:: scripts.coordinate_import :members: :undoc-members: :show-inheritance:
-scripts.cosmetic_changes script -------------------------------- +scripts.cosmetic_changes script +--------------------------------
.. automodule:: scripts.cosmetic_changes :members: :undoc-members: :show-inheritance:
-scripts.create_categories script --------------------------------- +scripts.create_categories script +---------------------------------
.. automodule:: scripts.create_categories :members: :undoc-members: :show-inheritance:
-scripts.data_ingestion script ------------------------------ +scripts.data_ingestion script +------------------------------
.. automodule:: scripts.data_ingestion :members: @@ -180,8 +203,8 @@ :undoc-members: :show-inheritance:
-scripts.fixing_redirects script -------------------------------- +scripts.fixing_redirects script +--------------------------------
.. automodule:: scripts.fixing_redirects :members: @@ -212,11 +235,16 @@ :undoc-members: :show-inheritance:
-scripts.harvest_template script -------------------------------- +scripts.harvest_template script +--------------------------------
-scripts.illustrate_wikidata script ----------------------------------- +.. automodule:: scripts.harvest_template + :members: + :undoc-members: + :show-inheritance: + +scripts.illustrate_wikidata script +-----------------------------------
.. automodule:: scripts.illustrate_wikidata :members: @@ -239,8 +267,8 @@ :undoc-members: :show-inheritance:
-scripts.imagecopy_self script ------------------------------ +scripts.imagecopy_self script +------------------------------
.. automodule:: scripts.imagecopy_self :members: @@ -281,6 +309,12 @@
scripts.interwiki script ------------------------ + +.. automodule:: scripts.interwiki + :members: + :exclude-members: Subject + :undoc-members: + :show-inheritance:
scripts.interwikidata script ---------------------------- @@ -330,8 +364,8 @@ :undoc-members: :show-inheritance:
-scripts.match_images script ---------------------------- +scripts.match_images script +----------------------------
.. automodule:: scripts.match_images :members: @@ -413,6 +447,11 @@ scripts.protect script ----------------------
+.. automodule:: scripts.protect + :members: + :undoc-members: + :show-inheritance: + scripts.redirect script -----------------------
@@ -432,8 +471,8 @@ :undoc-members: :show-inheritance:
-scripts.replicate_wiki script ------------------------------ +scripts.replicate_wiki script +------------------------------
.. automodule:: scripts.replicate_wiki :members: @@ -448,8 +487,8 @@ :undoc-members: :show-inheritance:
-scripts.script_wui script -------------------------- +scripts.script_wui script +--------------------------
.. automodule:: scripts.script_wui :members: @@ -472,8 +511,8 @@ :undoc-members: :show-inheritance:
-scripts.solve_disambiguation script ------------------------------------ +scripts.solve_disambiguation script +------------------------------------
.. automodule:: scripts.solve_disambiguation :members: @@ -488,26 +527,26 @@ :undoc-members: :show-inheritance:
-scripts.standardize_interwiki script ------------------------------------- +scripts.standardize_interwiki script +-------------------------------------
.. automodule:: scripts.standardize_interwiki :members: :undoc-members: :show-inheritance:
-scripts.states_redirect script ------------------------------- +scripts.states_redirect script +-------------------------------
.. automodule:: scripts.states_redirect :members: :undoc-members: :show-inheritance:
-scripts.surnames_redirect script --------------------------------- +scripts.surnames_redirects script +----------------------------------
-.. automodule:: scripts.surnames_redirect +.. automodule:: scripts.surnames_redirects :members: :undoc-members: :show-inheritance: @@ -609,4 +648,6 @@ .. automodule:: scripts.wikisourcetext :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: + + diff --git a/docs/scripts/scripts.userscripts.rst b/docs/scripts/scripts.userscripts.rst new file mode 100644 index 0000000..cafa711 --- /dev/null +++ b/docs/scripts/scripts.userscripts.rst @@ -0,0 +1,8 @@ +scripts.userscripts user scripts +================================ + +.. automodule:: scripts.userscripts + :members: + :undoc-members: + :show-inheritance: + diff --git a/pywikibot/bot.py b/pywikibot/bot.py index 802ab04..71bb5a0 100644 --- a/pywikibot/bot.py +++ b/pywikibot/bot.py @@ -1021,7 +1021,7 @@ -v useful in debugging.
-cosmeticchanges Toggles the cosmetic_changes setting made in config.py or --cc user_config.py to its inverse and overrules it. All other +-cc user-config.py to its inverse and overrules it. All other settings and restrictions are untouched.
-simulate Disables writing to the server. Useful for testing and diff --git a/pywikibot/comms/eventstreams.py b/pywikibot/comms/eventstreams.py index fb86530..0b790b3 100644 --- a/pywikibot/comms/eventstreams.py +++ b/pywikibot/comms/eventstreams.py @@ -152,8 +152,7 @@ def register_filter(self, *args, **kwargs): """Register a filter.
- Filter types - ============ + Filter types:
There are 3 types of filter: 'all', 'any' and 'none'. The filter type must be given with the keyword argument 'ftype' @@ -167,8 +166,7 @@ - B{'all'}: Skip if not all filter matches. Otherwise check 'any': - B{'any'}: Skip if no given filter matches. Otherwise pass.
- Filter functions - ================ + Filter functions:
Filter may be specified as external function methods given as positional argument like:: @@ -182,8 +180,7 @@ a parameter and that method must handle it in a proper way and return C{True} if the filter matches and C{False} otherwise.
- Filter keys and values - ====================== + Filter keys and values:
Another method to register a filter is to pass pairs of keys and values as keyword arguments to this method. The key must be a key of the event diff --git a/pywikibot/config2.py b/pywikibot/config2.py index 35ede44..cf9e6b0 100644 --- a/pywikibot/config2.py +++ b/pywikibot/config2.py @@ -821,7 +821,7 @@
# cosmetic_changes_deny_script is a list of scripts for which cosmetic changes # are disabled. You may add additional scripts by appending script names in -# your user_config.py ("+=" operator is strictly recommended): +# your user-config.py ("+=" operator is strictly recommended): # cosmetic_changes_deny_script += ['your_script_name_1', 'your_script_name_2'] # Appending the script name also works: # cosmetic_changes_deny_script.append('your_script_name') @@ -829,7 +829,7 @@ 'newitem', 'touch']
# ############# REPLICATION BOT ################ -# You can add replicate_replace to your user_config.py, which has the following +# You can add replicate_replace to your user-config.py, which has the following # format: # # replicate_replace = { diff --git a/pywikibot/families/lyricwiki_family.py b/pywikibot/families/lyricwiki_family.py index 2727357..a155703 100644 --- a/pywikibot/families/lyricwiki_family.py +++ b/pywikibot/families/lyricwiki_family.py @@ -12,7 +12,7 @@
# The LyricWiki family
-# user_config.py: +# user-config.py: # usernames['lyricwiki']['en'] = 'user' class Family(family.SingleSiteFamily, family.WikiaFamily):
diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index 9ecdf2e..ee51204 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -135,7 +135,7 @@ redirects) -logevents:delete,,20 gives 20 pages from deletion log -logevents:protect,Usr gives pages from protect by user Usr - -logevents:patrol,Usr,20 gives 20 patroled pages by Usr + -logevents:patrol,Usr,20 gives 20 patroled pages by Usr -logevents:upload,,20121231,20100101 gives upload pages in the 2010s, 2011s, and 2012s -logevents:review,,20121231 gives review pages since the @@ -171,7 +171,7 @@ given as -recentchanges:x, will work on the x most recently changed pages. If given as -recentchanges:offset,duration it will work on pages changed from 'offset' minutes with - 'duration' minutes of timespan. rctags are supported too. + 'duration' minutes of timespan. rctags are supported too. The rctag must be the very first parameter part.
Examples: diff --git a/scripts/README.rst b/scripts/README.rst index 3fac119..3e11786 100644 --- a/scripts/README.rst +++ b/scripts/README.rst @@ -23,6 +23,8 @@ +========================+=========================================================+ | add_text.py | Adds text at the top or end of pages. | +------------------------+---------------------------------------------------------+ + | archivebot.py | Archives discussion threads. | + +------------------------+---------------------------------------------------------+ | basic.py | Is a template from which simple bots can be made. | +------------------------+---------------------------------------------------------+ | blockpagechecker.py | Deletes any protection templates that are on pages | @@ -89,8 +91,6 @@ +------------------------+---------------------------------------------------------+ | editarticle.py | Edit a Wikipedia article with your favourite editor | +------------------------+---------------------------------------------------------+ - | featured.py | A robot to check feature articles. | - +------------------------+---------------------------------------------------------+ | fixing_redirects.py | Correct all redirect links of processed pages. | +------------------------+---------------------------------------------------------+ | flickrripper.py | Upload images from Flickr easily. | @@ -130,6 +130,8 @@ | interwiki.py | A robot to check interwiki links on all pages (or | | | a range of pages) of a wiki. | +------------------------+---------------------------------------------------------+ + | interwikidata.py | Script to handle interwiki links based on Wikibase. | + +------------------------+---------------------------------------------------------+ | isbn.py | Bot to convert all ISBN-10 codes to the ISBN-13 | | | format. | +------------------------+---------------------------------------------------------+ @@ -150,7 +152,7 @@ +------------------------+---------------------------------------------------------+ | movepages.py | Bot page moves to another title. | +------------------------+---------------------------------------------------------+ - | #ndashredir.py | Creates hyphenated redirects to articles with n dash | + | ndashredir.py | Creates hyphenated redirects to articles with n dash | | | or m dash in their title. | +------------------------+---------------------------------------------------------+ | newitem.py | Script creates new items on Wikidata based on criteria. | @@ -225,6 +227,8 @@ | | [[Special:Statistics]] in a table on a wiki page. | | | Thus it creates and updates a statistics wikitable. | +------------------------+---+-----------------------------------------------------+ + | surnames_redirects.py | Bot to create redirects based on name order. | + +------------------------+---------------------------------------------------------+ | table2wiki.py | Semi-automatic converting HTML-tables to wiki-tables | +------------------------+---------------------------------------------------------+ | template.py | change one template (that is {{...}}) into another. | @@ -253,24 +257,28 @@ +------------------------+---------------------------------------------------------+ | welcome.py | Script to welcome new users. | +------------------------+---------------------------------------------------------+ + | wikisourcetext.py | This bot applies to wikisource sites to upload text. | + +------------------------+---------------------------------------------------------+
- +-----------------------------------------------------------------------------------+ - | archive | Scripts no longer maintained. | - +========================+==========================================================+ - | archivebot.py | Archives discussion threads. | - +------------------------+----------------------------------------------------------+ + +----------------------------------------------------------------------------------+ + | archive | Scripts no longer maintained. | + +========================+=========================================================+ + | featured.py | A robot to check feature articles. | + +------------------------+---------------------------------------------------------+
- +-----------------------------------------------------------------------------------+ - | Others | - +========================+==========================================================+ - | i18n (folder) | Contains i18n translations for bot edit summaries. | - +------------------------+----------------------------------------------------------+ - | maintenance (folder) | Contains maintenance scripts for the developing team. | - +------------------------+----------------------------------------------------------+ - | README.rst | This file (Short info of all scripts). | - +------------------------+----------------------------------------------------------+ + +----------------------------------------------------------------------------------+ + | Others | + +========================+=========================================================+ + | i18n (folder) | Contains i18n translations for bot edit summaries. | + +------------------------+---------------------------------------------------------+ + | maintenance (folder) | Contains maintenance scripts for the developing team. | + +------------------------+---------------------------------------------------------+ + | userscripts (folder) | Empty folder for user scripts. | + +------------------------+---------------------------------------------------------+ + | README.rst | This file (Short info of all scripts). | + +------------------------+---------------------------------------------------------+
**External software can be used with Pywikibot:** * PyGoogle to access Google Web API and PySearch to access Yahoo! Search diff --git a/scripts/archive/README b/scripts/archive/README.rst similarity index 100% rename from scripts/archive/README rename to scripts/archive/README.rst diff --git a/scripts/archivebot.py b/scripts/archivebot.py index 21a8eaa..87eaf2f 100755 --- a/scripts/archivebot.py +++ b/scripts/archivebot.py @@ -17,16 +17,16 @@
Trancluded template may contain the following parameters:
-{{TEMPLATE_PAGE -|archive = -|algo = -|counter = -|maxarchivesize = -|minthreadsleft = -|minthreadstoarchive = -|archiveheader = -|key = -}} + {{TEMPLATE_PAGE + |archive = + |algo = + |counter = + |maxarchivesize = + |minthreadsleft = + |minthreadstoarchive = + |archiveheader = + |key = + }}
Meanings of parameters are:
diff --git a/scripts/harvest_template.py b/scripts/harvest_template.py index 0869356..e0418c5 100755 --- a/scripts/harvest_template.py +++ b/scripts/harvest_template.py @@ -5,11 +5,11 @@
Usage (see below for explanations and examples):
-* python pwb.py harvest_template -transcludes:"..." \ +- python pwb.py harvest_template -transcludes:"..." \ [default optional arguments] \ template_parameter PID [local optional arguments] \ [template_parameter PID [local optional arguments]] -* python pwb.py harvest_template [generators] -template:"..." \ +- python pwb.py harvest_template [generators] -template:"..." \ [default optional arguments] \ template_parameter PID [local optional arguments] \ [template_parameter PID [local optional arguments]] diff --git a/scripts/maintenance/README b/scripts/maintenance/README deleted file mode 100644 index 09c332f..0000000 --- a/scripts/maintenance/README +++ /dev/null @@ -1,2 +0,0 @@ -This directory/folder is reserved for maintaining scripts and helper scripts -only. diff --git a/scripts/protect.py b/scripts/protect.py index 8791124..dc66338 100755 --- a/scripts/protect.py +++ b/scripts/protect.py @@ -33,7 +33,8 @@
For all protection types (edit, move, etc.) it chooses the default protection level. This is "sysop" or "all" if -unprotect was selected. If multiple --unprotect or -default are used, only the last occurrence is applied. +parameters -unprotect or -default are used, only the last occurrence +is applied.
Usage: python protect.py <OPTIONS>
diff --git a/scripts/replicate_wiki.py b/scripts/replicate_wiki.py index 187a009..72bd12b 100755 --- a/scripts/replicate_wiki.py +++ b/scripts/replicate_wiki.py @@ -15,7 +15,7 @@ pages have to be changed if -r is not present, and will only actually write pages if -r /is/ present.
-You can add replicate_replace to your user_config.py, which has the following +You can add replicate_replace to your user-config.py, which has the following format:
replicate_replace = { diff --git a/scripts/wikisourcetext.py b/scripts/wikisourcetext.py index b363958..30b2cc5 100644 --- a/scripts/wikisourcetext.py +++ b/scripts/wikisourcetext.py @@ -25,10 +25,11 @@ Page range to upload; optional, start=1, end=djvu file number of images. Page ranges can be specified as: - A-B -> pages A until B - A- -> pages A until number of images - A -> just page A - -B -> pages 1 until B + + | A-B -> pages A until B + | A- -> pages A until number of images + | A -> just page A + | -B -> pages 1 until B
-showdiff: show difference between curent text and new text when saving the page diff --git a/tests/script_tests.py b/tests/script_tests.py index 6e290d1..7ade52a 100644 --- a/tests/script_tests.py +++ b/tests/script_tests.py @@ -136,7 +136,7 @@ # Some of these are not pretty, but at least they are informative # and not backtraces starting deep in the pywikibot package. no_args_expected_results = { - # TODO: until done here, remember to set editor = None in user_config.py + # TODO: until done here, remember to set editor = None in user-config.py 'checkimages': 'Execution time: 0 seconds', 'editarticle': 'Nothing changed', 'featured': '0 pages written.',
pywikibot-commits@lists.wikimedia.org