doc: add schema to index, fix schema link reference

jason810496 · Jul 21, 2024 · e537857 · e537857
1 parent 6c01871
commit e537857
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 8 deletions.
diff --git a/doc/api-reference.rst b/doc/api-reference.rst
@@ -14,22 +14,18 @@ API Reference
     :member-order: bysource
     :special-members: __init__
 
-schema.Message
---------------
 
 .. autoclass:: pgmq_sqlalchemy.schema.Message
     :members:
     :undoc-members:
     :inherited-members:
     :exclude-members: __init__
-    :noindex:
+
 
-schema.QueueMetrics
--------------------
 
 .. autoclass:: pgmq_sqlalchemy.schema.QueueMetrics
     :members:
     :undoc-members:
     :inherited-members:
     :exclude-members: __init__
-    :noindex:
+
diff --git a/pgmq_sqlalchemy/schema.py b/pgmq_sqlalchemy/schema.py
@@ -6,7 +6,7 @@
 @dataclass
 class Message:
     """
-    .. _schema_message_class: `schema.Message`_
+    .. _schema_message_class: #pgmq_sqlalchemy.schema.Message
     .. |schema_message_class| replace:: :py:class:`.~pgmq_sqlalchemy.schema.Message`
     """
 
@@ -20,7 +20,7 @@ class Message:
 @dataclass
 class QueueMetrics:
     """
-    .. _schema_queue_metrics_class: `schema.QueueMetrics`_
+    .. _schema_queue_metrics_class: #pgmq_sqlalchemy.schema.QueueMetrics
     .. |schema_queue_metrics_class| replace:: :py:class:`.~pgmq_sqlalchemy.schema.QueueMetrics`
     """