diff mbox series

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

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

Commit Message

Peter Maydell Feb. 1, 2019, 2:50 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>

---
 docs/conf.py | 3 +++
 1 file changed, 3 insertions(+)

-- 
2.20.1

Comments

Alex Bennée Feb. 1, 2019, 4:43 p.m. UTC | #1
Peter Maydell <peter.maydell@linaro.org> writes:

> 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>


> ---

>  docs/conf.py | 3 +++

>  1 file changed, 3 insertions(+)

>

> diff --git a/docs/conf.py b/docs/conf.py

> index 348e6358740..6ddaa549f28 100644

> --- a/docs/conf.py

> +++ b/docs/conf.py

> @@ -112,6 +112,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 ------------------------------------------



--
Alex Bennée
diff mbox series

Patch

diff --git a/docs/conf.py b/docs/conf.py
index 348e6358740..6ddaa549f28 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -112,6 +112,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 ------------------------------------------