On 24.08.23 17:40, Nishanth Menon wrote:
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/[email protected]/
Suggested-by: Mattijs Korpershoek <[email protected]>
Signed-off-by: Nishanth Menon <[email protected]>
Looks good to me.
---
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']
We copied our conf.py from kernel.org. Please, check if it can be added
upstream.
/linux$ scripts/get_maintainer.pl Documentation/conf.py
Jonathan Corbet <[email protected]> (maintainer:DOCUMENTATION)
[email protected] (open list:DOCUMENTATION)
[email protected] (open list)
[email protected] (open list:BPF [MISC])
Does the extension exist on their minimum Sphinx version (1.7) or at
least on the 2.24 in Documentation/requirements.txt?
Best regards
Heinrich
#
# 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
