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

#1428 update websupport API doc

Browse Source 
* ``staticdir`` was not correctly documented
* ```staticroot`` was not correctly documented at all
This commit is contained in:
Timotheus Kampik 2018-04-07 17:24:50 +02:00
parent 6030e7390d
commit 39678b7a61
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.
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