1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
sphinx-sqlalchemy
=================
Sphinx extension for documenting SQLAlchemy ORMs.
Usage
-----
Install ``sphinx_sqlalchemy``:
.. code-block:: bash
pip install sphinx_sqlalchemy
Add ``sphinx_sqlalchemy`` to your ``conf.py``:
.. code-block:: python
extensions = [
'sphinx_sqlalchemy',
]
Example
-------
::
.. sqla-model:: example.models.User
.. sqla-model:: ~example.models.Address
.. sqla-model:: example.models.User
.. sqla-model:: ~example.models.Address
This was created from:
.. literalinclude:: example/models.py
:lines: 1-
|
