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

Add and document html_extra_path option.

Browse Source
This commit is contained in:
Matthias C. M. Troffaes 2013-08-22 08:51:06 +01:00
parent 88c72be190
commit 57aceed4ed
3 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/config.rst
View File

@ -509,10 +509,11 @@ that use Sphinx' HTMLWriter class.
.. confval:: html_static_path .. confval:: html_static_path
A list of paths that contain custom static files (such as style sheets or A list of paths that contain custom static files (such as style
script files). Relative paths are taken as relative to the configuration sheets or script files). Relative paths are taken as relative to
directory. They are copied to the output directory after the theme's static the configuration directory. They are copied to the output's
files, so a file named :file:`default.css` will overwrite the theme's :file:`_static` directory after the theme's static files, so a file
named :file:`default.css` will overwrite the theme's
:file:`default.css`. :file:`default.css`.
.. versionchanged:: 0.4 .. versionchanged:: 0.4
@ -521,6 +522,15 @@ that use Sphinx' HTMLWriter class.
.. versionchanged:: 1.0 .. versionchanged:: 1.0
The entries in :confval:`html_static_path` can now be single files. The entries in :confval:`html_static_path` can now be single files.
.. confval:: html_extra_path
A list of paths that contain extra files (such as
:file:`robots.txt` or :file:`.htaccess`). Relative paths are taken
as relative to the configuration directory. They are copied to the
output directory, and will overwrite any existing generated file.
.. versionadded:: 1.2
.. confval:: html_last_updated_fmt .. confval:: html_last_updated_fmt
If this is not the empty string, a 'Last updated on:' timestamp is inserted If this is not the empty string, a 'Last updated on:' timestamp is inserted

1
sphinx/config.py
View File

@ -86,6 +86,7 @@ class Config(object):
html_logo = (None, 'html'), html_logo = (None, 'html'),
html_favicon = (None, 'html'), html_favicon = (None, 'html'),
html_static_path = ([], 'html'), html_static_path = ([], 'html'),
html_extra_path = ([], 'html'),
# the real default is locale-dependent # the real default is locale-dependent
html_last_updated_fmt = (None, 'html'), html_last_updated_fmt = (None, 'html'),
html_use_smartypants = (True, 'html'), html_use_smartypants = (True, 'html'),

5
sphinx/quickstart.py
View File

@ -171,6 +171,11 @@ html_theme = 'default'
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['%(dot)sstatic'] html_static_path = ['%(dot)sstatic']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
#html_last_updated_fmt = '%%b %%d, %%Y' #html_last_updated_fmt = '%%b %%d, %%Y'