Skip to content

Commit

Permalink
libbpf: Improve libbpf API documentation link position
Browse files Browse the repository at this point in the history
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 <[email protected]>
Signed-off-by: Daniel Borkmann <[email protected]>
Link: https://lore.kernel.org/bpf/[email protected]
  • Loading branch information
grantseltzer authored and borkmann committed Apr 22, 2022
1 parent b71a2eb commit e8c5e1a
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions Documentation/bpf/libbpf/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected] mailing list.
You can `subscribe <http://vger.kernel.org/vger-lists.html#bpf>`_ to the
Expand Down

0 comments on commit e8c5e1a

Please sign in to comment.