jenkins-bot submitted this change.

View Change

[doc] split tools in documentation, show titles only

Change-Id: Ic097e4b8b6a7104a67a31b2ab9417e0376a9abad
---
M docs/api_ref/index.rst
D docs/api_ref/pywikibot.tools.rst
A docs/api_ref/tools/pywikibot.tools.rst
A docs/api_ref/tools/tools.chars.rst
A docs/api_ref/tools/tools.collections.rst
A docs/api_ref/tools/tools.djvu.rst
A docs/api_ref/tools/tools.formatter.rst
A docs/api_ref/tools/tools.itertools.rst
A docs/api_ref/tools/tools.threading.rst
9 files changed, 55 insertions(+), 55 deletions(-)

diff --git a/docs/api_ref/index.rst b/docs/api_ref/index.rst
index 5db1b21..80a967a 100644
--- a/docs/api_ref/index.rst
+++ b/docs/api_ref/index.rst
@@ -21,7 +21,7 @@
 
 .. toctree::
    :glob:
-   :maxdepth: 2
+   :titlesonly:
 
    pywikibot
    pywikibot.config
@@ -44,3 +44,4 @@
    pywikibot.userinterfaces
    logging
    *
+   tools/*
diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst
deleted file mode 100644
index c126021..0000000
--- a/docs/api_ref/pywikibot.tools.rst
+++ /dev/null
@@ -1,54 +0,0 @@
-***********************************************
-:mod:`tools` --- Miscellaneous Helper Functions
-***********************************************
-
-.. automodule:: tools
-   :synopsis: Miscellaneous helper functions (not wiki-dependent)
-
-:mod:`tools.chars` --- Character Based Helper Functions
-=======================================================
-
-.. automodule:: tools.chars
-   :synopsis: Character based helper functions (not wiki-dependent)
-
-:mod:`tools.collections` --- Container datatypes
-================================================
-
-.. automodule:: tools.collections
-   :synopsis: Collections datatypes
-
-:mod:`tools.deprecate` --- Deprecating Decorators and Classes
-=============================================================
-
-.. automodule:: tools._deprecate
-   :synopsis: Module providing deprecation decorators
-
-:mod:`tools.djvu` --- DJVU files wrapper
-========================================
-
-.. automodule:: tools.djvu
-   :synopsis: Wrapper around djvulibre to access djvu files properties and content
-
-:mod:`tools.formatter` --- Formatting Related Functions and Classes
-===================================================================
-
-.. automodule:: tools.formatter
-   :synopsis: Module containing various formatting related utilities
-
-:mod:`tools.itertools` --- Iterators for Efficient Looping
-==========================================================
-
-.. automodule:: tools.itertools
-   :synopsis: Iterator functions
-
-:mod:`tools.threading` --- Thread-based Classes
-===============================================
-
-.. automodule:: tools.threading
-   :synopsis: Threading classes
-
-:mod:`tools.\_logging` --- logging.Formatter Subclass
-=====================================================
-
-.. automodule:: tools._logging
-   :synopsis: Logging tools
diff --git a/docs/api_ref/tools/pywikibot.tools.rst b/docs/api_ref/tools/pywikibot.tools.rst
new file mode 100644
index 0000000..957c3e0
--- /dev/null
+++ b/docs/api_ref/tools/pywikibot.tools.rst
@@ -0,0 +1,18 @@
+***********************************************
+:mod:`tools` --- Miscellaneous Helper Functions
+***********************************************
+
+.. automodule:: tools
+   :synopsis: Miscellaneous helper functions (not wiki-dependent)
+
+:mod:`tools.deprecate` --- Deprecating Decorators and Classes
+=============================================================
+
+.. automodule:: tools._deprecate
+   :synopsis: Module providing deprecation decorators
+
+:mod:`tools.\_logging` --- logging.Formatter Subclass
+=====================================================
+
+.. automodule:: tools._logging
+   :synopsis: Logging tools
diff --git a/docs/api_ref/tools/tools.chars.rst b/docs/api_ref/tools/tools.chars.rst
new file mode 100644
index 0000000..7d8ea18
--- /dev/null
+++ b/docs/api_ref/tools/tools.chars.rst
@@ -0,0 +1,6 @@
+*******************************************************
+:mod:`tools.chars` --- Character Based Helper Functions
+*******************************************************
+
+.. automodule:: tools.chars
+   :synopsis: Character based helper functions (not wiki-dependent)
diff --git a/docs/api_ref/tools/tools.collections.rst b/docs/api_ref/tools/tools.collections.rst
new file mode 100644
index 0000000..730cf89
--- /dev/null
+++ b/docs/api_ref/tools/tools.collections.rst
@@ -0,0 +1,6 @@
+************************************************
+:mod:`tools.collections` --- Container datatypes
+************************************************
+
+.. automodule:: tools.collections
+   :synopsis: Collections datatypes
diff --git a/docs/api_ref/tools/tools.djvu.rst b/docs/api_ref/tools/tools.djvu.rst
new file mode 100644
index 0000000..f64a882
--- /dev/null
+++ b/docs/api_ref/tools/tools.djvu.rst
@@ -0,0 +1,6 @@
+****************************************
+:mod:`tools.djvu` --- DJVU files wrapper
+****************************************
+
+.. automodule:: tools.djvu
+   :synopsis: Wrapper around djvulibre to access djvu files properties and content
diff --git a/docs/api_ref/tools/tools.formatter.rst b/docs/api_ref/tools/tools.formatter.rst
new file mode 100644
index 0000000..9fa141a
--- /dev/null
+++ b/docs/api_ref/tools/tools.formatter.rst
@@ -0,0 +1,6 @@
+*******************************************************************
+:mod:`tools.formatter` --- Formatting Related Functions and Classes
+*******************************************************************
+
+.. automodule:: tools.formatter
+   :synopsis: Module containing various formatting related utilities
diff --git a/docs/api_ref/tools/tools.itertools.rst b/docs/api_ref/tools/tools.itertools.rst
new file mode 100644
index 0000000..f865ffb
--- /dev/null
+++ b/docs/api_ref/tools/tools.itertools.rst
@@ -0,0 +1,6 @@
+**********************************************************
+:mod:`tools.itertools` --- Iterators for Efficient Looping
+**********************************************************
+
+.. automodule:: tools.itertools
+   :synopsis: Iterator functions
diff --git a/docs/api_ref/tools/tools.threading.rst b/docs/api_ref/tools/tools.threading.rst
new file mode 100644
index 0000000..20350a5
--- /dev/null
+++ b/docs/api_ref/tools/tools.threading.rst
@@ -0,0 +1,5 @@
+***********************************************
+:mod:`tools.threading` --- Thread-based Classes
+***********************************************
+.. automodule:: tools.threading
+   :synopsis: Threading classes

To view, visit change 1044735. To unsubscribe, or for help writing mail filters, visit settings.