diff mbox series

[v3,06/12] docs/conf.py: Don't include rST sources in HTML build

Message ID 20190305172139.32662-7-peter.maydell@linaro.org
State Superseded
Headers show
Series Enable build and install of our rST docs | expand

Commit Message

Peter Maydell March 5, 2019, 5:21 p.m. UTC 
Sphinx defaults to including all the rST source files
in the HTML build and making each HTML page link to the
source file. Disable that.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>

Acked-by: Aleksandar Markovic <amarkovic@wavecomp.com>

Message-id: 20190228145624.24885-7-peter.maydell@linaro.org
---
 docs/conf.py | 3 +++
 1 file changed, 3 insertions(+)

-- 
2.20.1

Comments

Richard Henderson March 5, 2019, 10:42 p.m. UTC | #1 
On 3/5/19 9:21 AM, Peter Maydell wrote:
> Sphinx defaults to including all the rST source files

> in the HTML build and making each HTML page link to the

> source file. Disable that.

> 

> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

> Reviewed-by: Alex Bennée <alex.bennee@linaro.org>

> Acked-by: Aleksandar Markovic <amarkovic@wavecomp.com>

> Message-id: 20190228145624.24885-7-peter.maydell@linaro.org

> ---

>  docs/conf.py | 3 +++

>  1 file changed, 3 insertions(+)


Reviewed-by: Richard Henderson <richard.henderson@linaro.org>



r~
diff mbox series

Patch

diff --git a/docs/conf.py b/docs/conf.py
index d118757cbd3..d3018bc5395 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -113,6 +113,9 @@  html_sidebars = {
     ]
 }
 
+# Don't copy the rST source files to the HTML output directory,
+# and don't put links to the sources into the output HTML.
+html_copy_source = False
 
 # -- Options for HTMLHelp output ------------------------------------------