From: Nishanth Menon <nm@ti.com>
To: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>,
Neha Francis <n-francis@ti.com>, Tom Rini <trini@konsulko.com>
Cc: <u-boot@lists.denx.de>,
Mattijs Korpershoek <mkorpershoek@baylibre.com>,
Simon Glass <sjg@chromium.org>, Nishanth Menon <nm@ti.com>
Subject: [RFC PATCH 0/2] doc: sphinx: Add sphinx-prompt
Date: Thu, 24 Aug 2023 10:40:34 -0500 [thread overview]
Message-ID: <20230824154036.3650607-1-nm@ti.com> (raw)
Add Sphinx-prompt for more readable documentation and yet is
userfriendly for people to copy paste.
See https://lore.kernel.org/all/87fs48rgto.fsf@baylibre.com/
If this approach looks correct, please ack and I can convert the
doc/board/ti/*.rst segments off to prompt instead of code-block where
applicable.
Quick video to show the difference in experience: https://youtu.be/ylDrHXWGVgo
Nishanth Menon (2):
doc: sphinx: Add sphinx-prompt
doc: board: ti: k3: Convert to sphinx-prompt
doc/board/ti/k3.rst | 112 ++++++++++++++++++------------------
doc/conf.py | 2 +-
doc/sphinx/requirements.txt | 1 +
3 files changed, 59 insertions(+), 56 deletions(-)
--
2.40.0
next reply other threads:[~2023-08-24 15:40 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-24 15:40 Nishanth Menon [this message]
2023-08-24 15:40 ` [RFC PATCH 1/2] doc: sphinx: Add sphinx-prompt Nishanth Menon
2023-08-24 15:47 ` Heinrich Schuchardt
2023-08-24 16:16 ` Nishanth Menon
2023-08-27 5:56 ` Heinrich Schuchardt
2023-08-28 8:03 ` Mattijs Korpershoek
2023-08-24 15:40 ` [RFC PATCH 2/2] doc: board: ti: k3: Convert to sphinx-prompt Nishanth Menon
2023-08-24 15:50 ` Heinrich Schuchardt
2023-08-24 17:48 ` Nishanth Menon
2023-08-27 6:02 ` Heinrich Schuchardt
2023-08-28 8:07 ` Mattijs Korpershoek
2023-08-28 13:02 ` 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=20230824154036.3650607-1-nm@ti.com \
--to=nm@ti.com \
--cc=heinrich.schuchardt@canonical.com \
--cc=mkorpershoek@baylibre.com \
--cc=n-francis@ti.com \
--cc=sjg@chromium.org \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
/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