Fix Navigation Issues in Docs #2123
Conversation
|
Master branch: 7cc595a |
|
Master branch: 325d956 |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
a11b6c4
to
08f2137
Compare
kernel-patches-bot
force-pushed
the
bpf-next
branch
from
325d956
to
7cc595a
Compare
|
Master branch: 7cc595a |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
08f2137
to
8fe063c
Compare
|
Master branch: 325d956 |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
8fe063c
to
cffdfa8
Compare
|
Master branch: e504389 |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
cffdfa8
to
8c310bd
Compare
|
Master branch: a5bdc36 |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
8c310bd
to
83bd74c
Compare
|
Master branch: e47d0bf |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
83bd74c
to
fbf36fc
Compare
|
Master branch: 4746158 |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
fbf36fc
to
23a1dc7
Compare
|
Master branch: e12cd15 |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
23a1dc7
to
f08d6a3
Compare
|
Master branch: ebf7f6f |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
f08d6a3
to
e56b180
Compare
|
Master branch: d41bc48 |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
e56b180
to
607bfa9
Compare
This changes the type of underline used to follow the guidelines in Documentation/doc-guide/sphinx.rst which also ensures that the headings are rendered at the correct level in the HTML sidebar Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
This allows for documentation relating to BPF Program Types to be matched by the glob pattern prog_* for inclusion in a sphinx toctree Signed-off-by: Dave Tucker <dave@dtucker.co.uk> Acked-by: KP Singh <kpsingh@kernel.org>
This commit fixes the display of the BPF documentation in the sidebar
when rendered as HTML.
Before this patch, the sidebar would render as follows for some
sections:
| BPF Documentation
|- BPF Type Format (BTF)
|- BPF Type Format (BTF)
This was due to creating a heading in index.rst followed by
a sphinx toctree, where the file referenced carries the same
title as the section heading.
To fix this I applied a pattern that has been established in other
subfolders of Documentation:
1. Re-wrote index.rst to have a single toctree
2. Split the sections out in to their own files
Additionally maps.rst and programs.rst make use of a glob pattern to
include map_* or prog_* rst files in their toctree, meaning future map
or program type documentation will be automatically included.
Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
|
Master branch: db813d7 |
kernel-patches-bot
force-pushed
the
series/579421=>bpf-next
branch
from
607bfa9
to
4e71fd9
Compare
|
At least one diff in series https://patchwork.kernel.org/project/netdevbpf/list/?series=579421 irrelevant now. Closing PR. |
Pull request for series with
subject: Fix Navigation Issues in Docs
version: 1
url: https://patchwork.kernel.org/project/netdevbpf/list/?series=579421