mbox series

[0/2] Documentation: sphinx: Add sphinx-prompt

Message ID 20230824182107.3702766-1-nm@ti.com (mailing list archive)
Headers show
Series Documentation: sphinx: Add sphinx-prompt | expand

Message

Nishanth Menon Aug. 24, 2023, 6:21 p.m. UTC
Hi,
Discussion started off in u-boot documentation[1] and Heinrich
suggested[2] getting something similar done for kernel as well.

https://youtu.be/ItjdVa59jjE shows how this change helps.

I have picked just a trivial file to show the impact, but it can
probably get done for other files as well.

NOTE: I am a sphinx noob, so, there might be better approaches.
Suggestions welcome.

Nishanth Menon (2):
  Documentation: sphinx: Add sphinx-prompt
  Documentation: bpf: Use sphinx-prompt

 Documentation/bpf/libbpf/libbpf_build.rst | 20 ++++++++++----------
 Documentation/conf.py                     |  2 +-
 Documentation/sphinx/requirements.txt     |  1 +
 3 files changed, 12 insertions(+), 11 deletions(-)

[1] https://lore.kernel.org/all/87fs48rgto.fsf@baylibre.com/
[2] https://lore.kernel.org/r/Datecc5d8c56-546a-4cd7-6a78-1206e9675555@canonical.com