Tune up the docs so modules are presented better
On https://gabbi.readthedocs.io/ not all modules were present. Notably missing was suitemaker, which is kind of the key to the whole thing.
This commit is contained in:
parent
39c99cefe7
commit
011421df98
@ -1,5 +1,5 @@
|
||||
gabbi Package
|
||||
=================
|
||||
=============
|
||||
|
||||
:mod:`case` Module
|
||||
------------------
|
||||
@ -17,6 +17,14 @@ gabbi Package
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:mod:`suitemaker` Module
|
||||
------------------------
|
||||
|
||||
.. automodule:: gabbi.suitemaker
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:mod:`fixture` Module
|
||||
---------------------
|
||||
|
||||
@ -49,6 +57,14 @@ gabbi Package
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:mod:`reporter` Module
|
||||
----------------------
|
||||
|
||||
.. automodule:: gabbi.reporter
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:mod:`utils` Module
|
||||
-------------------
|
||||
|
||||
@ -57,6 +73,14 @@ gabbi Package
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:mod:`exception` Module
|
||||
-----------------------
|
||||
|
||||
.. automodule:: gabbi.exception
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:mod:`httpclient` Module
|
||||
------------------------
|
||||
|
||||
@ -64,3 +88,11 @@ gabbi Package
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:mod:`json_parser` Module
|
||||
-------------------------
|
||||
|
||||
.. automodule:: gabbi.json_parser
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
@ -52,7 +52,7 @@ def build_tests(path, loader, host=None, port=8001, intercept=None,
|
||||
:param intercept: WSGI app factory for wsgi-intercept.
|
||||
:param test_loader_name: Base name for test classes. Rarely used.
|
||||
:param fixture_module: Python module containing fixture classes.
|
||||
:param response_handers: ResponseHandler classes.
|
||||
:param response_handers: :class:`~gabbi.handlers.ResponseHandler` classes.
|
||||
:type response_handlers: List of ResponseHandler classes.
|
||||
:param prefix: A URL prefix for all URLs that are not fully qualified.
|
||||
:param url: A full URL to test against. Replaces host, port and prefix.
|
||||
|
@ -12,9 +12,9 @@
|
||||
# under the License.
|
||||
"""The code that creates a suite of tests.
|
||||
|
||||
The key piece of code ``test_suite_from_dict``. It produces a
|
||||
``gabbi.suite.GabbiSuite`` containing one or more
|
||||
``gabbi.case.HTTPTestCase``.
|
||||
The key piece of code is :meth:`test_suite_from_dict`. It produces a
|
||||
:class:`gabbi.suite.GabbiSuite` containing one or more
|
||||
:class:`gabbi.case.HTTPTestCase`.
|
||||
"""
|
||||
|
||||
import copy
|
||||
@ -167,7 +167,7 @@ def test_suite_from_dict(loader, test_base_name, suite_dict, test_directory,
|
||||
:param defaults: An optional dictionary of default values to be used
|
||||
in each test.
|
||||
:param tests: A list of individual tests, themselves each being a
|
||||
dictionary. TODO: link to the case.BASE_TEST.
|
||||
dictionary. See :data:`gabbi.case.BASE_TEST`.
|
||||
"""
|
||||
try:
|
||||
test_data = suite_dict['tests']
|
||||
|
Loading…
x
Reference in New Issue
Block a user