From e53785742ddde36265b42aaaad0ca9f537dbed24 Mon Sep 17 00:00:00 2001 From: jason810496 <810496@email.wlsh.tyc.edu.tw> Date: Sun, 21 Jul 2024 18:35:25 +0800 Subject: [PATCH] doc: add schema to index, fix schema link reference --- doc/api-reference.rst | 8 ++------ pgmq_sqlalchemy/schema.py | 4 ++-- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/doc/api-reference.rst b/doc/api-reference.rst index a329e4d..5ead79f 100644 --- 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: \ No newline at end of file + \ No newline at end of file diff --git a/pgmq_sqlalchemy/schema.py b/pgmq_sqlalchemy/schema.py index fa25898..2a4d3d0 100644 --- 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` """