BPF List
 help / color / mirror / Atom feed
* [PATCH] Improve libbpf API documentation link position
@ 2022-04-22  3:10 grantseltzer
  2022-04-22 14:30 ` patchwork-bot+netdevbpf
  0 siblings, 1 reply; 2+ messages in thread
From: grantseltzer @ 2022-04-22  3:10 UTC (permalink / raw)
  To: bpf; +Cc: andrii, Grant Seltzer

From: Grant Seltzer <grantseltzer@gmail.com>

This puts the link for libbpf API documentation into
the sidebar for much easier navigation.

You can preview this change at:

https://libbpf-test.readthedocs.io/en/latest/

Note that the link is hardcoded to the production version,
so you can see that it self references itself here for now:

https://libbpf-test.readthedocs.io/en/latest/api.html

This will need to make its way into the libbpf mirror, before
being deployed to libbpf.readthedocs.org

Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
---
 Documentation/bpf/libbpf/index.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/Documentation/bpf/libbpf/index.rst b/Documentation/bpf/libbpf/index.rst
index 4e8c656b539a..3722537d1384 100644
--- a/Documentation/bpf/libbpf/index.rst
+++ b/Documentation/bpf/libbpf/index.rst
@@ -6,14 +6,13 @@ libbpf
 .. toctree::
    :maxdepth: 1
 
+   API Documentation <https://libbpf.readthedocs.io/en/latest/api.html>
    libbpf_naming_convention
    libbpf_build
 
 This is documentation for libbpf, a userspace library for loading and
 interacting with bpf programs.
 
-For API documentation see the `versioned API documentation site <https://libbpf.readthedocs.io/en/latest/api.html>`_.
-
 All general BPF questions, including kernel functionality, libbpf APIs and
 their application, should be sent to bpf@vger.kernel.org mailing list.
 You can `subscribe <http://vger.kernel.org/vger-lists.html#bpf>`_ to the
-- 
2.34.1


^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2022-04-22 14:30 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-04-22  3:10 [PATCH] Improve libbpf API documentation link position grantseltzer
2022-04-22 14:30 ` patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox