From a903c7a6fc65917bfb24dbb57a8058a5ce6a0d3a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio=20=28Lunar=29?=
 <lunar@softwareheritage.org>
Date: Tue, 28 Mar 2023 18:11:57 +0200
Subject: [PATCH] Improve API reference entry page
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Make clear that the “API reference” page is an index of our modules.
Add a pointer to the “interface” part of the landing page for people
wanting to learn how to interact with Software Heritage.

Closes #4740
---
 docs/devel/api-reference.rst | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/docs/devel/api-reference.rst b/docs/devel/api-reference.rst
index 03853a4b..38fe0a2f 100644
--- a/docs/devel/api-reference.rst
+++ b/docs/devel/api-reference.rst
@@ -3,8 +3,16 @@
 API reference
 =============
 
+.. seealso::
+   Looking for ways to interact with our source code archive from your
+   applications or research projects? Learn :ref:`how to use Software Heritage
+   from your applications <landing-interface>`.
+
+Here is the reference documentation of Software Heritage own software stack
+by components:
+
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    swh.alter <swh-alter/index>
    swh.auth <swh-auth/index>
-- 
GitLab