Improved docs
This commit is contained in:
@@ -51,6 +51,8 @@ templates_path = ['_templates']
|
||||
exclude_patterns = [
|
||||
'cpl_cli/templates/*',
|
||||
'cpl_cli/*',
|
||||
'tests',
|
||||
'cpl_query/tests/*',
|
||||
'tests/*'
|
||||
]
|
||||
|
||||
@@ -65,4 +67,4 @@ html_theme = 'sphinx_rtd_theme'
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
html_static_path = ['_static']
|
||||
|
10
docs/source/cpl_query.exceptions.rst
Normal file
10
docs/source/cpl_query.exceptions.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
cpl_query.exceptions
|
||||
=================================
|
||||
|
||||
cpl_query.exceptions
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.exceptions
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
26
docs/source/cpl_query.extension.rst
Normal file
26
docs/source/cpl_query.extension.rst
Normal file
@@ -0,0 +1,26 @@
|
||||
cpl_query.extension
|
||||
=================================
|
||||
|
||||
cpl_query.extension.iterable_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.iterable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl_query.extension.list
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.list
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl_query.extension.ordered_iterable_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.ordered_iterable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
8
docs/source/cpl_query.rst
Normal file
8
docs/source/cpl_query.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
Query Reference
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_query.extension
|
||||
cpl_query.exceptions
|
@@ -8,5 +8,6 @@ This CPL docs help you learn, understand and use the package. From your first ap
|
||||
|
||||
- [Getting started](quickstart)
|
||||
- [Setup](setup)
|
||||
- [API Reference](cpl)
|
||||
- [API Reference](cpl_core)
|
||||
- [CLI Reference](cli.overview)
|
||||
- [Query Reference](cpl_query)
|
||||
|
Reference in New Issue
Block a user