From b8e84e20d8afbb660ccebcf3642055f329cd26e1 Mon Sep 17 00:00:00 2001
From: Martin Larralde <martin.larralde@embl.de>
Date: Tue, 16 Jul 2024 15:11:10 +0200
Subject: [PATCH] Add explicit module names to API reference section of the
docs [ci skip]
---
docs/api/daemon/index.rst | 6 +++---
docs/api/easel/index.rst | 4 ++--
docs/api/errors/index.rst | 6 +++---
docs/api/hmmer/index.rst | 4 ++--
docs/api/index.rst | 10 +++++-----
docs/api/plan7/index.rst | 4 ++--
6 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/docs/api/daemon/index.rst b/docs/api/daemon/index.rst
index cc096a25..bb9641a0 100644
--- a/docs/api/daemon/index.rst
+++ b/docs/api/daemon/index.rst
@@ -1,5 +1,5 @@
-Daemon
-======
+Daemon (`pyhmmer.daemon`)
+=========================
.. currentmodule:: pyhmmer.daemon
@@ -18,4 +18,4 @@ Client
:hidden:
:caption: Client
- Client <client>
\ No newline at end of file
+ Client <client>
diff --git a/docs/api/easel/index.rst b/docs/api/easel/index.rst
index ad43314a..30237b84 100644
--- a/docs/api/easel/index.rst
+++ b/docs/api/easel/index.rst
@@ -1,5 +1,5 @@
-Easel
-=====
+Easel (`pyhmmer.easel`)
+=======================
.. currentmodule:: pyhmmer.easel
diff --git a/docs/api/errors/index.rst b/docs/api/errors/index.rst
index 3c7c7cd1..6d0b58e0 100644
--- a/docs/api/errors/index.rst
+++ b/docs/api/errors/index.rst
@@ -1,5 +1,5 @@
-Errors
-======
+Errors (`pyhmmer.errors`)
+=========================
.. currentmodule:: pyhmmer.errors
@@ -50,4 +50,4 @@ Runtime Errors
:hidden:
:caption: Runtime Errors
- Runtime Errors <runtime>
\ No newline at end of file
+ Runtime Errors <runtime>
diff --git a/docs/api/hmmer/index.rst b/docs/api/hmmer/index.rst
index 82dc3413..e4d7b301 100644
--- a/docs/api/hmmer/index.rst
+++ b/docs/api/hmmer/index.rst
@@ -1,5 +1,5 @@
-HMMER
-=====
+HMMER (`pyhmmer.hmmer`)
+=======================
.. currentmodule:: pyhmmer.hmmer
diff --git a/docs/api/index.rst b/docs/api/index.rst
index 84dc9b76..267f14cb 100644
--- a/docs/api/index.rst
+++ b/docs/api/index.rst
@@ -9,8 +9,8 @@ This section contains a complete reference of the API of the different
.. toctree::
:maxdepth: 2
- HMMER <hmmer/index>
- Easel <easel/index>
- Plan7 <plan7/index>
- Daemon <daemon/index>
- Errors <errors/index>
+ hmmer/index
+ easel/index
+ plan7/index
+ daemon/index
+ errors/index
diff --git a/docs/api/plan7/index.rst b/docs/api/plan7/index.rst
index 1fcee76a..814c23c9 100644
--- a/docs/api/plan7/index.rst
+++ b/docs/api/plan7/index.rst
@@ -1,5 +1,5 @@
-Plan7
-=====
+Plan7 (`pyhmmer.plan7`)
+=======================
.. currentmodule:: pyhmmer.plan7
--
GitLab