IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4819 from TimKam/1428-web-support-wrong-static-param-doc

Browse Source 
#1428 update websupport API doc
This commit is contained in:
Takeshi KOMIYA 2018-04-12 23:43:31 +09:00 committed by GitHub
commit c12d616be9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/web/api.rst
View File

@ -40,9 +40,17 @@ The WebSupport Class
comment that was added. comment that was added.
staticdir staticdir
If static files are served from a location besides ``'/static'``, this If the static files should be created in a different location
should be a string with the name of that location **and not in** ``'/static'``, this should be a string with the name of
(e.g. ``'/static_files'``). 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 docroot
If the documentation is not served from the base path of a URL, this If the documentation is not served from the base path of a URL, this