]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
doc: sphinx: Add sphinx-prompt
authorNishanth Menon <nm@ti.com>
Thu, 24 Aug 2023 15:40:35 +0000 (10:40 -0500)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sun, 27 Aug 2023 06:21:08 +0000 (08:21 +0200)
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>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
doc/conf.py
doc/sphinx/requirements.txt

index 00f24136647742327cd0e5073eb74ecc0d864d74..5e2ff1c8f5e2c8da39f31da4c041c6105509afe4 100644 (file)
@@ -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*
index 4f411f78d030f060ec7dbad3832ef6a9931db1b7..6ccbe527ee791cc0b750bf65d29e35f8fe2f6a43 100644 (file)
@@ -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