BPF List
 help / color / mirror / Atom feed
From: Nishanth Menon <nm@ti.com>
To: Mauro Carvalho Chehab <mchehab@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: <linux-kernel@vger.kernel.org>, <linux-doc@vger.kernel.org>,
	<bpf@vger.kernel.org>,
	Heinrich Schuchardt <heinrich.schuchardt@canonical.com>,
	Mattijs Korpershoek <mkorpershoek@baylibre.com>,
	Simon Glass <sjg@chromium.org>, Tom Rini <trini@konsulko.com>,
	Neha Francis <n-francis@ti.com>, Nishanth Menon <nm@ti.com>
Subject: [PATCH 0/2] Documentation: sphinx: Add sphinx-prompt
Date: Thu, 24 Aug 2023 13:21:05 -0500	[thread overview]
Message-ID: <20230824182107.3702766-1-nm@ti.com> (raw)

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
-- 
2.40.0


             reply	other threads:[~2023-08-24 18:21 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-24 18:21 Nishanth Menon [this message]
2023-08-24 18:21 ` [PATCH 1/2] Documentation: sphinx: Add sphinx-prompt Nishanth Menon
2023-08-25 14:16   ` Daniel Borkmann
2023-08-25 22:46   ` Jonathan Corbet
2023-08-28 12:59     ` Nishanth Menon
2023-08-28 13:41       ` Jonathan Corbet
2023-08-28 13:51         ` Nishanth Menon
2023-08-28 14:09         ` Matthew Wilcox
2023-08-28 15:12           ` Jonathan Corbet
2023-08-28 17:25             ` Mauro Carvalho Chehab
2023-08-28 18:37               ` Jonathan Corbet
2023-08-24 18:21 ` [PATCH 2/2] Documentation: bpf: Use sphinx-prompt Nishanth Menon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230824182107.3702766-1-nm@ti.com \
    --to=nm@ti.com \
    --cc=bpf@vger.kernel.org \
    --cc=corbet@lwn.net \
    --cc=heinrich.schuchardt@canonical.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=mkorpershoek@baylibre.com \
    --cc=n-francis@ti.com \
    --cc=sjg@chromium.org \
    --cc=trini@konsulko.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox