jenkins-bot has submitted this change and it was merged.
Change subject: Add Flow modules to API docs ......................................................................
Add Flow modules to API docs
Bug: T109682 Change-Id: Ia91191349b4531e8fbdc0e661def276dc94d9abe --- M docs/api_ref/pywikibot.rst A docs/api_ref/tests/flow_edit_tests.rst A docs/api_ref/tests/flow_tests.rst M docs/api_ref/tests/index.rst 4 files changed, 44 insertions(+), 0 deletions(-)
Approvals: John Vandenberg: Looks good to me, approved jenkins-bot: Verified
diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index c18a64c..21c21b3 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -125,6 +125,14 @@ :undoc-members: :show-inheritance:
+pywikibot.flow module +---------------------- + +.. automodule:: pywikibot.flow + :members: + :undoc-members: + :show-inheritance: + pywikibot.i18n module ---------------------
diff --git a/docs/api_ref/tests/flow_edit_tests.rst b/docs/api_ref/tests/flow_edit_tests.rst new file mode 100644 index 0000000..c81ed1c --- /dev/null +++ b/docs/api_ref/tests/flow_edit_tests.rst @@ -0,0 +1,16 @@ +=============== +flow_edit_tests +=============== + Tests in ``tests.flow_edit_tests``: + +--------------- +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: diff --git a/docs/api_ref/tests/flow_tests.rst b/docs/api_ref/tests/flow_tests.rst new file mode 100644 index 0000000..124e266 --- /dev/null +++ b/docs/api_ref/tests/flow_tests.rst @@ -0,0 +1,18 @@ +========== +flow_tests +========== + Tests in ``tests.flow_tests``: + +--------------- +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: diff --git a/docs/api_ref/tests/index.rst b/docs/api_ref/tests/index.rst index 15cd9b6..224328f 100644 --- a/docs/api_ref/tests/index.rst +++ b/docs/api_ref/tests/index.rst @@ -38,6 +38,8 @@ wikibase_edit<./wikibase_edit_tests> upload<./upload_tests> oauth<./oauth_tests> + flow<./flow_tests> + flow_edit<./flow_edit_tests>
============ Script tests