diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-04-12 23:43:31 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-12 23:43:31 +0900 |
| commit | c12d616be90466d2b7f385a69665ef6a9c6fd74c (patch) | |
| tree | fe27f64e134713869aa6b2911786714ccb7d222a | |
| parent | 35e4bd498f7e0c41fd2e2f36246b905b8e99aeab (diff) | |
| parent | aa5a7e5916b323613b00d2fdd8faa0beff9f488d (diff) | |
| download | sphinx-git-c12d616be90466d2b7f385a69665ef6a9c6fd74c.tar.gz | |
Merge pull request #4819 from TimKam/1428-web-support-wrong-static-param-doc
#1428 update websupport API doc
| -rw-r--r-- | doc/web/api.rst | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/web/api.rst b/doc/web/api.rst index 05ea68e71..81d25b79f 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'``). + + .. note:: + If you specify ``staticdir``, you will typically want to adjust + ``staticroot`` accordingly. + + 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'``). docroot If the documentation is not served from the base path of a URL, this |