diff mbox series

[04/11] docs/conf.py: Disable unused _static directory

Message ID 20190201145035.22739-5-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
We don't yet have any custom static files, so disable this
config file setting to avoid a warning from sphinx about
not being able to find the directory.

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

---
 docs/conf.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

-- 
2.20.1

Comments

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

> We don't yet have any custom static files, so disable this

> config file setting to avoid a warning from sphinx about

> not being able to find the directory.

>

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


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



>  docs/conf.py | 6 +++++-

>  1 file changed, 5 insertions(+), 1 deletion(-)

>

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

> index 53a17506615..e1d08a34a65 100644

> --- a/docs/conf.py

> +++ b/docs/conf.py

> @@ -93,7 +93,11 @@ html_theme = 'alabaster'

>  # Add any paths that contain custom static files (such as style sheets) here,

>  # relative to this directory. They are copied after the builtin static files,

>  # so a file named "default.css" will overwrite the builtin "default.css".

> -html_static_path = ['_static']

> +# QEMU doesn't yet have any static files, so comment this out so we don't

> +# get a warning about a missing directory.

> +# If we do ever add this then it would probably be better to call the

> +# subdirectory sphinx_static, as the Linux kernel does.

> +# html_static_path = ['_static']

>

>  # Custom sidebar templates, must be a dictionary that maps document names

>  # to template names.



--
Alex Bennée
diff mbox series

Patch

diff --git a/docs/conf.py b/docs/conf.py
index 53a17506615..e1d08a34a65 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -93,7 +93,11 @@  html_theme = 'alabaster'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# QEMU doesn't yet have any static files, so comment this out so we don't
+# get a warning about a missing directory.
+# If we do ever add this then it would probably be better to call the
+# subdirectory sphinx_static, as the Linux kernel does.
+# html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.