mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge branch 'stable'
This commit is contained in:
4
CHANGES
4
CHANGES
@@ -74,6 +74,10 @@ Bugs fixed
|
|||||||
* C++, fix parsing of types prefixed with 'enum'.
|
* C++, fix parsing of types prefixed with 'enum'.
|
||||||
* #2023: Dutch search support uses Danish stemming info
|
* #2023: Dutch search support uses Danish stemming info
|
||||||
* C++, add support for user-defined literals.
|
* C++, add support for user-defined literals.
|
||||||
|
* On Py2 environment, conf.py that is generated by sphinx-quickstart should have u prefixed
|
||||||
|
config value for 'version' and 'release'.
|
||||||
|
* #2102: On Windows + Py3, using ``|today|`` and non-ASCII date format will raise
|
||||||
|
UnicodeEncodeError.
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|||||||
@@ -23,6 +23,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. class:: DirectoryHTMLBuilder
|
.. class:: DirectoryHTMLBuilder
|
||||||
@@ -36,6 +38,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 0.6
|
.. versionadded:: 0.6
|
||||||
@@ -48,6 +52,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 1.0
|
.. versionadded:: 1.0
|
||||||
@@ -61,6 +67,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. module:: sphinx.builders.qthelp
|
.. module:: sphinx.builders.qthelp
|
||||||
@@ -72,6 +80,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. _Qt help: http://qt-project.org/doc/qt-4.8/qthelp-framework.html
|
.. _Qt help: http://qt-project.org/doc/qt-4.8/qthelp-framework.html
|
||||||
@@ -96,6 +106,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 1.3
|
.. versionadded:: 1.3
|
||||||
@@ -109,6 +121,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. module:: sphinx.builders.epub
|
.. module:: sphinx.builders.epub
|
||||||
@@ -122,6 +136,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. module:: sphinx.builders.latex
|
.. module:: sphinx.builders.latex
|
||||||
@@ -145,6 +161,8 @@ The builder's "name" must be given to the **-b** command-line option of
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
Note that a direct PDF builder using ReportLab is available in `rst2pdf
|
Note that a direct PDF builder using ReportLab is available in `rst2pdf
|
||||||
@@ -162,6 +180,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 0.4
|
.. versionadded:: 0.4
|
||||||
@@ -175,6 +195,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 1.0
|
.. versionadded:: 1.0
|
||||||
@@ -196,6 +218,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 1.1
|
.. versionadded:: 1.1
|
||||||
@@ -261,6 +285,8 @@ for details.
|
|||||||
|
|
||||||
The old name ``web`` still works as well.
|
The old name ``web`` still works as well.
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
The file suffix is ``.fpickle``. The global context is called
|
The file suffix is ``.fpickle``. The global context is called
|
||||||
@@ -276,6 +302,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
The file suffix is ``.fjson``. The global context is called
|
The file suffix is ``.fjson``. The global context is called
|
||||||
@@ -293,6 +321,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 1.1
|
.. versionadded:: 1.1
|
||||||
@@ -307,6 +337,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. module:: sphinx.builders.linkcheck
|
.. module:: sphinx.builders.linkcheck
|
||||||
@@ -318,6 +350,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. module:: sphinx.builders.xml
|
.. module:: sphinx.builders.xml
|
||||||
@@ -329,6 +363,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 1.2
|
.. versionadded:: 1.2
|
||||||
@@ -343,6 +379,8 @@ for details.
|
|||||||
|
|
||||||
.. autoattribute:: name
|
.. autoattribute:: name
|
||||||
|
|
||||||
|
.. autoattribute:: format
|
||||||
|
|
||||||
.. autoattribute:: supported_image_types
|
.. autoattribute:: supported_image_types
|
||||||
|
|
||||||
.. versionadded:: 1.2
|
.. versionadded:: 1.2
|
||||||
|
|||||||
@@ -127,9 +127,9 @@ author = u'%(author_str)s'
|
|||||||
# built documents.
|
# built documents.
|
||||||
#
|
#
|
||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = '%(version_str)s'
|
version = u'%(version_str)s'
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = '%(release_str)s'
|
release = u'%(release_str)s'
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
@@ -715,7 +715,7 @@ if "%%1" == "clean" (
|
|||||||
|
|
||||||
|
|
||||||
REM Check if sphinx-build is available and fallback to Python version if any
|
REM Check if sphinx-build is available and fallback to Python version if any
|
||||||
%%SPHINXBUILD%% 2> nul
|
%%SPHINXBUILD%% 1>NUL 2>NUL
|
||||||
if errorlevel 9009 goto sphinx_python
|
if errorlevel 9009 goto sphinx_python
|
||||||
goto sphinx_ok
|
goto sphinx_ok
|
||||||
|
|
||||||
@@ -978,7 +978,7 @@ set SPHINXPROJ=%(project_fn)s
|
|||||||
|
|
||||||
if "%%1" == "" goto help
|
if "%%1" == "" goto help
|
||||||
|
|
||||||
%%SPHINXBUILD%% 2> nul
|
%%SPHINXBUILD%% >NUL 2>NUL
|
||||||
if errorlevel 9009 (
|
if errorlevel 9009 (
|
||||||
\techo.
|
\techo.
|
||||||
\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||||
|
|||||||
@@ -166,8 +166,14 @@ def ustrftime(format, *args):
|
|||||||
# given by LC_TIME; if that is available, use it
|
# given by LC_TIME; if that is available, use it
|
||||||
enc = locale.getlocale(locale.LC_TIME)[1] or 'utf-8'
|
enc = locale.getlocale(locale.LC_TIME)[1] or 'utf-8'
|
||||||
return time.strftime(text_type(format).encode(enc), *args).decode(enc)
|
return time.strftime(text_type(format).encode(enc), *args).decode(enc)
|
||||||
else:
|
else: # Py3
|
||||||
return time.strftime(format, *args)
|
# On Windows, time.strftime() and Unicode characters will raise UnicodeEncodeError.
|
||||||
|
# http://bugs.python.org/issue8304
|
||||||
|
try:
|
||||||
|
return time.strftime(format, *args)
|
||||||
|
except UnicodeEncodeError:
|
||||||
|
r = time.strftime(format.encode('unicode-escape').decode(), *args)
|
||||||
|
return r.encode().decode('unicode-escape')
|
||||||
|
|
||||||
|
|
||||||
def safe_relpath(path, start=None):
|
def safe_relpath(path, start=None):
|
||||||
|
|||||||
Reference in New Issue
Block a user