mirror of
https://github.com/simonw/sqlite-utils.git
synced 2026-08-25 02:34:24 +02:00
More docstrings plus configured autodoc, refs #311
This commit is contained in:
parent
ee469e3122
commit
b95b6b63f6
5 changed files with 158 additions and 20 deletions
55
docs/reference.rst
Normal file
55
docs/reference.rst
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
===========
|
||||
Reference
|
||||
===========
|
||||
|
||||
.. contents:: :local:
|
||||
|
||||
.. _reference_db_database:
|
||||
|
||||
sqlit_utils.db.Database
|
||||
=======================
|
||||
|
||||
.. autoclass:: sqlite_utils.db.Database
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:special-members: __getitem__
|
||||
:exclude-members: use_counts_table
|
||||
|
||||
.. _reference_db_queryable:
|
||||
|
||||
sqlit_utils.db.Queryable
|
||||
========================
|
||||
|
||||
.. autoclass:: sqlite_utils.db.Queryable
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. _reference_db_table:
|
||||
|
||||
sqlit_utils.db.Table
|
||||
====================
|
||||
|
||||
.. autoclass:: sqlite_utils.db.Table
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. _reference_db_view:
|
||||
|
||||
sqlit_utils.db.View
|
||||
===================
|
||||
|
||||
.. autoclass:: sqlite_utils.db.View
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. _reference_db_other:
|
||||
|
||||
Other
|
||||
=====
|
||||
|
||||
.. autoclass:: sqlite_utils.db.Column
|
||||
|
||||
.. autoclass:: sqlite_utils.db.ColumnDetails
|
||||
Loading…
Add table
Add a link
Reference in a new issue