public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
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 1/2] doc: sphinx: Add sphinx-prompt
Date: Thu, 24 Aug 2023 10:40:35 -0500	[thread overview]
Message-ID: <20230824154036.3650607-2-nm@ti.com> (raw)
In-Reply-To: <20230824154036.3650607-1-nm@ti.com>

Sphinx-prompt[1] helps bring-in '.. prompt::' option that allows a
better rendered documentation, yet be able to copy paste without
picking up the prompt from rendered documentation.

[1] https://lore.kernel.org/all/87fs48rgto.fsf@baylibre.com/
Suggested-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
Signed-off-by: Nishanth Menon <nm@ti.com>
---
Version picked is the best that works with Sphinx 3.4.3

 doc/conf.py                 | 2 +-
 doc/sphinx/requirements.txt | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/conf.py b/doc/conf.py
index 00f241366477..5e2ff1c8f5e2 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -39,7 +39,7 @@ needs_sphinx = '2.4.4'
 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
               'kfigure', 'sphinx.ext.ifconfig', # 'automarkup',
               'maintainers_include', 'sphinx.ext.autosectionlabel',
-              'kernel_abi', 'kernel_feat']
+              'kernel_abi', 'kernel_feat', 'sphinx-prompt']
 
 #
 # cdomain is badly broken in Sphinx 3+.  Leaving it out generates *most*
diff --git a/doc/sphinx/requirements.txt b/doc/sphinx/requirements.txt
index 4f411f78d030..6ccbe527ee79 100644
--- a/doc/sphinx/requirements.txt
+++ b/doc/sphinx/requirements.txt
@@ -15,6 +15,7 @@ requests==2.31.0
 six==1.16.0
 snowballstemmer==2.2.0
 Sphinx==3.4.3
+sphinx-prompt==1.5.0
 sphinx-rtd-theme==1.0.0
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-devhelp==1.0.2
-- 
2.40.0


  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 [RFC PATCH 0/2] doc: sphinx: Add sphinx-prompt Nishanth Menon
2023-08-24 15:40 ` Nishanth Menon [this message]
2023-08-24 15:47   ` [RFC PATCH 1/2] " 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-2-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