From 39678b7a61de603c5bccf30fffc0f981a5bc90da Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sat, 7 Apr 2018 17:24:50 +0200 Subject: [PATCH] #1428 update websupport API doc * ``staticdir`` was not correctly documented * ```staticroot`` was not correctly documented at all --- doc/web/api.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/web/api.rst b/doc/web/api.rst index 05ea68e71..841ccb093 100644 --- a/doc/web/api.rst +++ b/doc/web/api.rst @@ -40,9 +40,17 @@ The WebSupport Class comment that was added. staticdir - If static files are served from a location besides ``'/static'``, this - should be a string with the name of that location - (e.g. ``'/static_files'``). + If the static files should be created in a different location + **and not in** ``'/static'``, this should be a string with the name of + that location (e.g. ``builddir + '/static_files'``). + + staticroot + If the static files are not served from ``'/static'``, this should be a + string with the name of that location (e.g. ``'/static_files'``). + + .. note:: + If you specify ``staticdir``, you will typically want to adjust + ``staticroot`` accordingly. docroot If the documentation is not served from the base path of a URL, this