Skip to content

Commit e537857

Browse files
committed
doc: add schema to index, fix schema link reference
1 parent 6c01871 commit e537857

File tree

2 files changed

+4
-8
lines changed

2 files changed

+4
-8
lines changed

doc/api-reference.rst

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,18 @@ API Reference
1414
:member-order: bysource
1515
:special-members: __init__
1616

17-
schema.Message
18-
--------------
1917

2018
.. autoclass:: pgmq_sqlalchemy.schema.Message
2119
:members:
2220
:undoc-members:
2321
:inherited-members:
2422
:exclude-members: __init__
25-
:noindex:
23+
2624

27-
schema.QueueMetrics
28-
-------------------
2925

3026
.. autoclass:: pgmq_sqlalchemy.schema.QueueMetrics
3127
:members:
3228
:undoc-members:
3329
:inherited-members:
3430
:exclude-members: __init__
35-
:noindex:
31+

pgmq_sqlalchemy/schema.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
@dataclass
77
class Message:
88
"""
9-
.. _schema_message_class: `schema.Message`_
9+
.. _schema_message_class: #pgmq_sqlalchemy.schema.Message
1010
.. |schema_message_class| replace:: :py:class:`.~pgmq_sqlalchemy.schema.Message`
1111
"""
1212

@@ -20,7 +20,7 @@ class Message:
2020
@dataclass
2121
class QueueMetrics:
2222
"""
23-
.. _schema_queue_metrics_class: `schema.QueueMetrics`_
23+
.. _schema_queue_metrics_class: #pgmq_sqlalchemy.schema.QueueMetrics
2424
.. |schema_queue_metrics_class| replace:: :py:class:`.~pgmq_sqlalchemy.schema.QueueMetrics`
2525
"""
2626

0 commit comments

Comments
 (0)