Autogenerate module docs with sphinxcontrib-apidocmaster

11 files changed, 27 insertions, 723 deletions

diff --git a/docs/conf.py b/docs/conf.py
index c277b6e4..11129319 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -80,12 +80,16 @@ rst_epilog = f"""
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    # Stdlib extensions:
     'sphinx.ext.autodoc',
     'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
+
+    # Third-party extensions:
+    'sphinxcontrib.apidoc',
     'rst.linker',
     'jaraco.packaging.sphinx',
 ]
@@ -238,3 +242,17 @@ link_files = {
 # Ref: https://github.com/python-attrs/attrs/pull/571/files\
 #      #diff-85987f48f1258d9ee486e3191495582dR82
 default_role = 'any'
+
+
+# -- Options for apidoc extension ----------------------------------------
+
+apidoc_excluded_paths = []
+apidoc_extra_args = [
+    '--implicit-namespaces',
+    '--private',  # include “_private” modules
+]
+apidoc_module_dir = '../cherrypy'
+apidoc_module_first = False
+apidoc_output_dir = 'pkg'
+apidoc_separate_modules = True
+apidoc_toc_file = None
diff --git a/docs/index.rst b/docs/index.rst
index bbd0fe6d..a2e35029 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -19,7 +19,12 @@ CherryPy — A Minimalist Python Web Framework
    development.rst
    glossary.rst
    history.rst
-   pkg/modules.rst
+
+.. toctree::
+   :hidden:
+   :caption: Reference
+
+   pkg/modules
 
 `CherryPy <http://www.cherrypy.org>`_ is a pythonic, object-oriented web framework.
 
diff --git a/docs/pkg/.gitignore b/docs/pkg/.gitignore
new file mode 100644
index 00000000..d6b7ef32
--- /dev/null
+++ b/docs/pkg/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
diff --git a/docs/pkg/cherrypy.lib.rst b/docs/pkg/cherrypy.lib.rst
deleted file mode 100644
index 8df1261c..00000000
--- a/docs/pkg/cherrypy.lib.rst
+++ /dev/null
@@ -1,142 +0,0 @@
-cherrypy.lib package
-====================
-
-Submodules
-----------
-
-cherrypy.lib.auth_basic module
-------------------------------
-
-.. automodule:: cherrypy.lib.auth_basic
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.auth_digest module
--------------------------------
-
-.. automodule:: cherrypy.lib.auth_digest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.caching module
----------------------------
-
-.. automodule:: cherrypy.lib.caching
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.covercp module
----------------------------
-
-.. automodule:: cherrypy.lib.covercp
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.cpstats module
----------------------------
-
-.. automodule:: cherrypy.lib.cpstats
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.cptools module
----------------------------
-
-.. automodule:: cherrypy.lib.cptools
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.encoding module
-----------------------------
-
-.. automodule:: cherrypy.lib.encoding
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.gctools module
----------------------------
-
-.. automodule:: cherrypy.lib.gctools
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.httputil module
-----------------------------
-
-.. automodule:: cherrypy.lib.httputil
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.jsontools module
------------------------------
-
-.. automodule:: cherrypy.lib.jsontools
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.locking module
----------------------------
-
-.. automodule:: cherrypy.lib.locking
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.profiler module
-----------------------------
-
-.. automodule:: cherrypy.lib.profiler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.reprconf module
-----------------------------
-
-.. automodule:: cherrypy.lib.reprconf
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.sessions module
-----------------------------
-
-.. automodule:: cherrypy.lib.sessions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.static module
---------------------------
-
-.. automodule:: cherrypy.lib.static
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.lib.xmlrpcutil module
-------------------------------
-
-.. automodule:: cherrypy.lib.xmlrpcutil
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: cherrypy.lib
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/pkg/cherrypy.process.rst b/docs/pkg/cherrypy.process.rst
deleted file mode 100644
index 86fa5436..00000000
--- a/docs/pkg/cherrypy.process.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-cherrypy.process package
-========================
-
-Submodules
-----------
-
-cherrypy.process.plugins module
--------------------------------
-
-.. automodule:: cherrypy.process.plugins
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.process.servers module
--------------------------------
-
-.. automodule:: cherrypy.process.servers
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.process.win32 module
------------------------------
-
-.. automodule:: cherrypy.process.win32
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.process.wspbus module
-------------------------------
-
-.. automodule:: cherrypy.process.wspbus
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: cherrypy.process
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/pkg/cherrypy.rst b/docs/pkg/cherrypy.rst
deleted file mode 100644
index 38599fa1..00000000
--- a/docs/pkg/cherrypy.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-cherrypy package
-================
-
-Subpackages
------------
-
-.. toctree::
-
-    cherrypy.lib
-    cherrypy.process
-    cherrypy.scaffold
-    cherrypy.test
-    cherrypy.tutorial
-
-Submodules
-----------
-
-cherrypy.daemon module
-----------------------
-
-.. automodule:: cherrypy.daemon
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: cherrypy
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/pkg/cherrypy.scaffold.rst b/docs/pkg/cherrypy.scaffold.rst
deleted file mode 100644
index c13adbf0..00000000
--- a/docs/pkg/cherrypy.scaffold.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-cherrypy.scaffold package
-=========================
-
-Module contents
----------------
-
-.. automodule:: cherrypy.scaffold
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/pkg/cherrypy.test.rst b/docs/pkg/cherrypy.test.rst
deleted file mode 100644
index de05e292..00000000
--- a/docs/pkg/cherrypy.test.rst
+++ /dev/null
@@ -1,390 +0,0 @@
-cherrypy.test package
-=====================
-
-Submodules
-----------
-
-cherrypy.test.benchmark module
-------------------------------
-
-.. automodule:: cherrypy.test.benchmark
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.checkerdemo module
---------------------------------
-
-.. automodule:: cherrypy.test.checkerdemo
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.helper module
----------------------------
-
-.. automodule:: cherrypy.test.helper
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.logtest module
-----------------------------
-
-.. automodule:: cherrypy.test.logtest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.modfastcgi module
--------------------------------
-
-.. automodule:: cherrypy.test.modfastcgi
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.modfcgid module
------------------------------
-
-.. automodule:: cherrypy.test.modfcgid
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.modpy module
---------------------------
-
-.. automodule:: cherrypy.test.modpy
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.modwsgi module
-----------------------------
-
-.. automodule:: cherrypy.test.modwsgi
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.sessiondemo module
---------------------------------
-
-.. automodule:: cherrypy.test.sessiondemo
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_auth_basic module
-------------------------------------
-
-.. automodule:: cherrypy.test.test_auth_basic
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_auth_digest module
--------------------------------------
-
-.. automodule:: cherrypy.test.test_auth_digest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_bus module
------------------------------
-
-.. automodule:: cherrypy.test.test_bus
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_caching module
----------------------------------
-
-.. automodule:: cherrypy.test.test_caching
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_compat module
---------------------------------
-
-.. automodule:: cherrypy.test.test_compat
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_config module
---------------------------------
-
-.. automodule:: cherrypy.test.test_config
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_config_server module
----------------------------------------
-
-.. automodule:: cherrypy.test.test_config_server
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_conn module
-------------------------------
-
-.. automodule:: cherrypy.test.test_conn
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_core module
-------------------------------
-
-.. automodule:: cherrypy.test.test_core
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_dynamicobjectmapping module
-----------------------------------------------
-
-.. automodule:: cherrypy.test.test_dynamicobjectmapping
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_encoding module
-----------------------------------
-
-.. automodule:: cherrypy.test.test_encoding
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_etags module
--------------------------------
-
-.. automodule:: cherrypy.test.test_etags
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_http module
-------------------------------
-
-.. automodule:: cherrypy.test.test_http
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_httplib module
----------------------------------
-
-.. automodule:: cherrypy.test.test_httplib
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_iterator module
-----------------------------------
-
-.. automodule:: cherrypy.test.test_iterator
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_json module
-------------------------------
-
-.. automodule:: cherrypy.test.test_json
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_logging module
----------------------------------
-
-.. automodule:: cherrypy.test.test_logging
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_mime module
-------------------------------
-
-.. automodule:: cherrypy.test.test_mime
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_misc_tools module
-------------------------------------
-
-.. automodule:: cherrypy.test.test_misc_tools
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_objectmapping module
----------------------------------------
-
-.. automodule:: cherrypy.test.test_objectmapping
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_params module
---------------------------------
-
-.. automodule:: cherrypy.test.test_params
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_proxy module
--------------------------------
-
-.. automodule:: cherrypy.test.test_proxy
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_refleaks module
-----------------------------------
-
-.. automodule:: cherrypy.test.test_refleaks
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_request_obj module
--------------------------------------
-
-.. automodule:: cherrypy.test.test_request_obj
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_routes module
---------------------------------
-
-.. automodule:: cherrypy.test.test_routes
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_session module
----------------------------------
-
-.. automodule:: cherrypy.test.test_session
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_sessionauthenticate module
----------------------------------------------
-
-.. automodule:: cherrypy.test.test_sessionauthenticate
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_states module
---------------------------------
-
-.. automodule:: cherrypy.test.test_states
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_static module
---------------------------------
-
-.. automodule:: cherrypy.test.test_static
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_tools module
--------------------------------
-
-.. automodule:: cherrypy.test.test_tools
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_tutorials module
------------------------------------
-
-.. automodule:: cherrypy.test.test_tutorials
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_virtualhost module
--------------------------------------
-
-.. automodule:: cherrypy.test.test_virtualhost
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_wsgi_ns module
----------------------------------
-
-.. automodule:: cherrypy.test.test_wsgi_ns
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_wsgi_unix_socket module
-------------------------------------------
-
-.. automodule:: cherrypy.test.test_wsgi_unix_socket
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_wsgi_vhost module
-------------------------------------
-
-.. automodule:: cherrypy.test.test_wsgi_vhost
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_wsgiapps module
-----------------------------------
-
-.. automodule:: cherrypy.test.test_wsgiapps
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.test_xmlrpc module
---------------------------------
-
-.. automodule:: cherrypy.test.test_xmlrpc
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.test.webtest module
-----------------------------
-
-.. automodule:: cherrypy.test.webtest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: cherrypy.test
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/pkg/cherrypy.tutorial.rst b/docs/pkg/cherrypy.tutorial.rst
deleted file mode 100644
index 3676e0ba..00000000
--- a/docs/pkg/cherrypy.tutorial.rst
+++ /dev/null
@@ -1,94 +0,0 @@
-cherrypy.tutorial package
-=========================
-
-Submodules
-----------
-
-cherrypy.tutorial.tut01_helloworld module
------------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut01_helloworld
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut02_expose_methods module
----------------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut02_expose_methods
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut03_get_and_post module
--------------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut03_get_and_post
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut04_complex_site module
--------------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut04_complex_site
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut05_derived_objects module
-----------------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut05_derived_objects
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut06_default_method module
----------------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut06_default_method
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut07_sessions module
----------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut07_sessions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut08_generators_and_yield module
----------------------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut08_generators_and_yield
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut09_files module
-------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut09_files
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-cherrypy.tutorial.tut10_http_errors module
-------------------------------------------
-
-.. automodule:: cherrypy.tutorial.tut10_http_errors
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: cherrypy.tutorial
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/pkg/modules.rst b/docs/pkg/modules.rst
deleted file mode 100644
index 9c68b63a..00000000
--- a/docs/pkg/modules.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-Modules
-=======
-
-.. toctree::
-   :maxdepth: 4
-
-   cherrypy
diff --git a/setup.py b/setup.py
index 5c715e89..2483bb3b 100644
--- a/setup.py
+++ b/setup.py
@@ -73,6 +73,7 @@ params = dict(
             'sphinx',
             'docutils',
             'alabaster',
+            'sphinxcontrib-apidoc>=0.3.0',
             'rst.linker>=1.11',
             'jaraco.packaging>=3.2',
         ],