diff options
| author | Nishanth Menon <nm@ti.com> | 2023-08-24 10:40:35 -0500 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2023-08-27 08:21:08 +0200 |
| commit | 1cfcc2298fc6c1d661db2f7b5110e2c63e0ef756 (patch) | |
| tree | 370ea8f15d4337d9e6fe44b84ce0a0957080decb | |
| parent | 96c4fec7019a3c5d4410c01d2f5ecbc6a547dc81 (diff) | |
doc: sphinx: Add sphinx-prompt
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>
| -rw-r--r-- | doc/conf.py | 2 | ||||
| -rw-r--r-- | doc/sphinx/requirements.txt | 1 |
2 files changed, 2 insertions, 1 deletions
diff --git a/doc/conf.py b/doc/conf.py index 00f2413664..5e2ff1c8f5 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 4f411f78d0..6ccbe527ee 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 |