Skip to content

Initial Update

Chris Spencer requested to merge pyup-initial-update into master

Created by: pyup-bot

This is my first visit to this fine repo so I have bundled all updates in a single pull request to make things easier for you to merge.

Close this pull request and delete the branch if you want me to start with single pull requests right away

Here's the executive summary:

Updates

Here's a list of all the updates bundled in this pull request. I've added some links to make it easier for you to find all the information you need.

six 1.10.0 » 1.10.0 PyPI | Changelog | Homepage | Docs
sphinx-rtd-theme 0.1.9 » 0.1.9 PyPI | Repo
Sphinx 1.5.1 » 1.5.1 PyPI | Changelog | Homepage
pytest 3.0.5 » 3.0.5 PyPI | Changelog | Homepage
mock 2.0.0 » 2.0.0 PyPI | Repo
pytest-cache 1.0 » 1.0 PyPI | Changelog | Repo | Docs

Changelogs

six -> 1.10.0

1.10.0

  • Issue 122: Improve the performance of six.int2byte on Python 3.
  • Pull request 55 and issue 99: Don't add the winreg module to six.moves on non-Windows platforms.
  • Pull request 60 and issue 108: Add six.moves.getcwd and six.moves.getcwdu.
  • Pull request 64: Add create_unbound_method to create unbound methods.

1.9.0

  • Issue 106: Support the flush parameter to six.print_.
  • Pull request 48 and issue 15: Add the python_2_unicode_compatible decorator.
  • Pull request 57 and issue 50: Add several compatibility methods for unittest assertions that were renamed between Python 2 and 3.
  • Issue 105 and pull request 58: Ensure six.wraps respects the updated and assigned arguments.
  • Issue 102: Add raise_from to abstract out Python 3's raise from syntax.
  • Issue 97: Optimize six.iterbytes on Python 2.
  • Issue 98: Fix six.moves race condition in multi-threaded code.
  • Pull request 51: Add six.view(keys|values|itmes), which provide dictionary views on Python 2.7+.
  • Issue 112: six.moves.reload_module now uses the importlib module on Python 3.4+.

1.8.0

  • Issue 90: Add six.moves.shlex_quote.
  • Issue 59: Add six.moves.intern.
  • Add six.urllib.parse.uses_(fragment|netloc|params|query|relative).
  • Issue 88: Fix add_metaclass when the class has __slots__ containing __weakref__ or __dict__.
  • Issue 89: Make six use absolute imports.
  • Issue 85: Always accept updated and assigned arguments for wraps().
  • Issue 86: In reraise(), instantiate the exception if the second argument is None.
  • Pull request 45: Add six.moves.email_mime_nonmultipart.
  • Issue 81: Add six.urllib.request.splittag mapping.
  • Issue 80: Add six.urllib.request.splituser mapping.

1.7.3

  • Issue 77: Fix import six on Python 3.4 with a custom loader.
  • Issue 74: six.moves.xmlrpc_server should map to SimpleXMLRPCServer on Python 2 as documented not xmlrpclib.

1.7.2

  • Issue 72: Fix installing on Python 2.

1.7.1

  • Issue 71: Make the six.moves meta path importer handle reloading of the six module gracefully.

1.7.0

  • Pull request 30: Implement six.moves with a PEP 302 meta path hook.
  • Pull request 32: Add six.wraps, which is like functools.wraps but always sets the wrapped attribute.
  • Pull request 35: Improve add_metaclass, so that it doesn't end up inserting another class into the hierarchy.
  • Pull request 34: Add import mappings for dummy_thread.
  • Pull request 33: Add import mappings for UserDict and UserList.
  • Pull request 31: Select the implementations of dictionary iterator routines at import time for a 20% speed boost.

1.6.1

  • Raise an AttributeError for six.moves.X when X is a module not available in the current interpreter.

1.6.0

  • Raise an AttributeError for every attribute of unimportable modules.
  • Issue 56: Make the fake modules six.moves puts into sys.modules appear not to have a path unless they are loaded.
  • Pull request 28: Add support for SplitResult.
  • Issue 55: Add move mapping for xmlrpc.server.
  • Pull request 29: Add move for urllib.parse.splitquery.

1.5.2

  • Issue 53: Make the fake modules six.moves puts into sys.modules appear not to have a name unless they are loaded.

1.5.1

  • Issue 51: Hack around the Django autoreloader after recent six.moves changes.

1.5.0

  • Removed support for Python 2.4. This is because py.test no longer supports 2.4.
  • Fix various import problems including issues 19 and 41. six.moves modules are now lazy wrappers over the underlying modules instead of the actual modules themselves.
  • Issue 49: Add six.moves mapping for tkinter.ttk.
  • Pull request 24: Add dir special method to six.moves modules.
  • Issue 47: Fix add_metaclass on classes with a string for the slots variable.
  • Issue 44: Fix interpretation of backslashes on Python 2 in the u() function.
  • Pull request 21: Add import mapping for urllib's proxy_bypass function.
  • Issue 43: Add import mapping for the Python 2 xmlrpclib module.
  • Issue 39: Add import mapping for the Python 2 thread module.
  • Issue 40: Add import mapping for the Python 2 gdbm module.
  • Issue 35: On Python versions less than 2.7, print_ now encodes unicode strings when outputing to standard streams. (Python 2.7 handles this automatically.)

1.4.1

  • Issue 32: urllib module wrappings don't work when six is not a toplevel file.

1.4.0

  • Issue 31: Add six.moves mapping for UserString.
  • Pull request 12: Add six.add_metaclass, a decorator for adding a metaclass to a class.
  • Add six.moves.zip_longest and six.moves.filterfalse, which correspond respectively to itertools.izip_longest and itertools.ifilterfalse on Python 2 and itertools.zip_longest and itertools.filterfalse on Python 3.
  • Issue 25: Add the unichr function, which returns a string for a Unicode codepoint.
  • Issue 26: Add byte2int function, which complements int2byte.
  • Add a PY2 constant with obvious semantics.
  • Add helpers for indexing and iterating over bytes: iterbytes and indexbytes.
  • Add create_bound_method() wrapper.
  • Issue 23: Allow multiple base classes to be passed to with_metaclass.
  • Issue 24: Add six.moves.range alias. This exactly the same as the current xrange alias.
  • Pull request 5: Create six.moves.urllib, which contains abstractions for a bunch of things which are in urllib in Python 3 and spread out across urllib, urllib2, and urlparse in Python 2.

1.3.0

  • Issue 21: Add methods to access the closure and globals of a function.
  • In six.iter(items/keys/values/lists), passed keyword arguments through to the underlying method.
  • Add six.iterlists().
  • Issue 20: Fix tests if tkinter is not available.
  • Issue 17: Define callable to be builtin callable when it is available again in Python 3.2+.
  • Issue 16: Rename Python 2 exec_'s arguments, so casually calling exec_ with keyword arguments will raise.
  • Issue 14: Put the six.moves package in sys.modules based on the name six is imported under.
  • Fix Jython detection.
  • Pull request 4: Add email_mime_multipart, email_mime_text, and email_mime_base to six.moves.

1.2.0

  • Issue 13: Make iterkeys/itervalues/iteritems return iterators on Python 3 instead of iterables.
  • Issue 11: Fix maxsize support on Jython.
  • Add six.next() as an alias for six.advance_iterator().
  • Use the builtin next() function for advance_iterator() where is available (2.6+), not just Python 3.
  • Add the Iterator class for writing portable iterators.

1.1.0

  • Add the int2byte function.
  • Add compatibility mappings for iterators over the keys, values, and items of a dictionary.
  • Fix six.MAXSIZE on platforms where sizeof(long) != sizeof(Py_ssize_t).
  • Issue 3: Add six.moves mappings for filter, map, and zip.

1.0.0

  • Issue 2: u() on Python 2.x now resolves unicode escapes.
  • Expose an API for adding mappings to six.moves.

1.0

  • Reworked six into one .py file. This breaks imports. Please tell me if you are interested in an import compatibility layer.

Sphinx -> 1.5.1

1.5.1

=====================================

Features added

  • 3214: Allow to suppress "unknown mimetype" warnings from epub builder using :confval:suppress_warnings.

Bugs fixed

  • 3195: Can not build in parallel
  • 3198: AttributeError is raised when toctree has 'self'
  • 3211: Remove untranslated sphinx locale catalogs (it was covered by untranslated it_IT)
  • 3212: HTML Builders crashes with docutils-0.13
  • 3207: more latex problems with references inside parsed-literal directive (\DUrole)
  • 3205: sphinx.util.requests crashes with old pyOpenSSL (< 0.14)
  • 3220: KeyError when having a duplicate citation
  • 3200: LaTeX: xref inside desc_name not allowed
  • 3228: build_sphinx command crashes when missing dependency
  • 2469: Ignore updates of catalog files for gettext builder. Thanks to Hiroshi Ohkubo.
  • 3183: Randomized jump box order in generated index page.

1.5

  • 3069: Even if &#39;babel&#39; key is set to empty string, LaTeX output contains one \addto\captions...
  • 3123: user &#39;babel&#39; key setting is not obeyed anymore
  • 3155: Fix JavaScript for html_sourcelink_suffix fails with IE and Opera
  • 3085: keep current directory after breaking build documentation. Thanks to Timotheus Kampik.
  • 3181: pLaTeX crashes with a section contains endash
  • 3180: latex: add stretch/shrink between successive singleline or multipleline cpp signatures (ref 3072)
  • 3128: globing images does not support .svgz file
  • 3015: fix a broken test on Windows.
  • 1843: Fix documentation of descriptor classes that have a custom metaclass. Thanks to Erik Bray.
  • 3190: util.split_docinfo fails to parse multi-line field bodies
  • 3024, 3037: In Python3, application.Sphinx._log crushed when the log message cannot be encoded into console encoding.

Testing

  • To simplify, sphinx uses external mock package even if unittest.mock exists.

1.5b1

  • 2432: Fix unwanted * between varargs and keyword only args. Thanks to Alex Grönholm.
  • 3062: Failed to build PDF using 1.5a2 (undefined \hypersetup for Japanese documents since PR3030)
  • Better rendering of multiline signatures in html.
  • 777: LaTeX output "too deeply nested" (ref 3096)
  • Let LaTeX image inclusion obey scale before textwidth fit (ref 2865, 3059)
  • 3019: LaTeX fails on description of C function with arguments (ref 3083)
  • fix latex inline literals where &lt; &gt; - gobbled a space

1.5a2

  • 2810: Problems with pdflatex in an Italian document
  • Use latex_elements.papersize to specify papersize of LaTeX in Makefile
  • 2988: linkcheck: retry with GET request if denied HEAD request
  • 2990: linkcheck raises "Can't convert 'bytes' object to str implicitly" error if linkcheck_anchors enabled
  • 3004: Invalid link types "top" and "up" are used
  • 3009: Bad rendering of parsed-literals in LaTeX since Sphinx 1.4.4
  • 3000: option directive generates invalid HTML anchors
  • 2984: Invalid HTML has been generated if html_split_index enabled
  • 2986: themes/basic/defindex.html should be changed for html5 friendly
  • 2987: Invalid HTML has been generated if multiple IDs are assigned to a list
  • 2891: HTML search does not provide all the results
  • 1986: Title in PDF Output
  • 147: Problem with latex chapter style
  • 3018: LaTeX problem with page layout dimensions and chapter titles
  • Fix an issue with \pysigline in LaTeX style file (ref 3023)
  • 3038: sphinx.ext.math* raises TypeError if labels are duplicated
  • 3031: incompatibility with LaTeX package tocloft
  • 3003: literal blocks in footnotes are not supported by Latex
  • 3047: spacing before footnote in pdf output is not coherent and allows breaks
  • 3045: HTML search index creator should ignore "raw" content if now html
  • 3039: English stemmer returns wrong word if the word is capitalized
  • Fix make-mode Makefile template (ref 3056, 2936)

1.5a1

  • 2707: (latex) the column width is badly computed for tabular
  • 2799: Sphinx installs roles and directives automatically on importing sphinx module. Now Sphinx installs them on running application.
  • sphinx.ext.autodoc crashes if target code imports * from mock modules by autodoc_mock_imports.
  • 1953: Sphinx.add_node does not add handlers the translator installed by html_translator_class
  • 1797: text builder inserts blank line on top
  • 2894: quickstart main() doesn't use argv argument
  • 2874: gettext builder could not extract all text under the only directives
  • 2485: autosummary crashes with multiple source_suffix values
  • 1734: Could not translate the caption of toctree directive
  • Could not translate the content of meta directive (ref: 1734)
  • 2550: external links are opened in help viewer
  • 2687: Running Sphinx multiple times produces 'already registered' warnings

1.4.9

=====================================

Bugs fixed

  • 2936: Fix doc/Makefile that can't build man because doc/man exists
  • 3058: Using the same 'caption' attribute in multiple 'toctree' directives results in warning / error
  • 3068: Allow the '=' character in the -D option of sphinx-build.py
  • 3074: add_source_parser() crashes in debug mode
  • 3135: sphinx.ext.autodoc crashes with plain Callable
  • 3150: Fix query word splitter in JavaScript. It behaves as same as Python's regular expression.
  • 3093: gettext build broken on substituted images.
  • 3093: gettext build broken on image node under note directive.
  • imgmath: crashes on showing error messages if image generation failed
  • 3117: LaTeX writer crashes if admonition is placed before first section title
  • 3164: Change search order of sphinx.ext.inheritance_diagram

1.4.8

====================================

Bugs fixed

  • 2996: The wheel package of Sphinx got crash with ImportError

1.4.7

====================================

Bugs fixed

  • 2890: Quickstart should return an error consistently on all error conditions
  • 2870: flatten genindex columns' heights.
  • 2856: Search on generated HTML site doesnt find some symbols
  • 2882: Fall back to a GET request on 403 status in linkcheck
  • 2902: jsdump.loads fails to load search index if keywords starts with underscore
  • 2900: Fix epub content.opf: add auto generated orphan files to spine.
  • 2899: Fix hasdoc() function in Jinja2 template. It can detect genindex, search collectly.
  • 2901: Fix epub result: skip creating links from image tags to original image files.
  • 2917: inline code is hyphenated on HTML
  • 1462: autosummary warns for namedtuple with attribute with trailing underscore
  • Could not reference equations if :nowrap: option specified
  • 2873: code-block overflow in latex (due to commas)
  • 1060, 2056: sphinx.ext.intersphinx: broken links are generated if relative paths are used in intersphinx_mapping
  • 2931: code-block directive with same :caption: causes warning of duplicate target. Now code-block and literalinclude does not define hyperlink target using its caption automatially.
  • 2962: latex: missing label of longtable
  • 2968: autodoc: show-inheritance option breaks docstrings

1.4.6

=====================================

Incompatible changes

  • 2867: linkcheck builder crashes with six-1.4. Now Sphinx depends on six-1.5 or later

Bugs fixed

  • applehelp: Sphinx crashes if hiutil or codesign commands not found
  • Fix make clean abort issue when build dir contains regular files like DS_Store.
  • Reduce epubcheck warnings/errors:
  • Fix DOCTYPE to html5
  • Change extension from .html to .xhtml.
  • Disable search page on epub results
  • 2778: Fix autodoc crashes if obj.dict is a property method and raises exception
  • Fix duplicated toc in epub3 output.
  • 2775: Fix failing linkcheck with servers not supporting identidy encoding
  • 2833: Fix formatting instance annotations in ext.autodoc.
  • 1911: -D option of sphinx-build does not override the extensions variable
  • 2789: sphinx.ext.intersphinx generates wrong hyperlinks if the inventory is given
  • parsing errors for caption of code-blocks are displayed in document (ref: 2845)
  • 2846: singlehtml builder does not include figure numbers
  • 2816: Fix data from builds cluttering the Domain.initial_data class attributes

1.4.5

=====================================

Incompatible changes

  • latex, inclusion of non-inline images from image directive resulted in non-coherent whitespaces depending on original image width; new behaviour by necessity differs from earlier one in some cases. (ref: 2672)
  • latex, use of \includegraphics to refer to Sphinx custom variant is deprecated; in future it will revert to original LaTeX macro, custom one already has alternative name \sphinxincludegraphics.

Features added

  • new config option latex_keep_old_macro_names, defaults to True. If False, lets macros (for text styling) be defined only with \sphinx-prefixed names.
  • latex writer allows user customization of "shadowed" boxes (topics), via three length variables.
  • woff-format web font files now supported by the epub builder.

Bugs fixed

  • jsdump fix for python 3: fixes the HTML search on python > 3
  • 2676: (latex) Error with verbatim text in captions since Sphinx 1.4.4
  • 2629: memoir class crashes LaTeX. Fixed by latex_keep_old_macro_names=False (ref 2675)
  • 2684: sphinx.ext.intersphinx crashes with six-1.4.1
  • 2679: float package needed for &#39;figure_align&#39;: &#39;H&#39; latex option
  • 2671: image directive may lead to inconsistent spacing in pdf
  • 2705: toctree generates empty bullet_list if :titlesonly: specified
  • 2479: sphinx.ext.viewcode uses python2 highlighter by default
  • 2700: HtmlHelp builder has hard coded index.html
  • latex, since 1.4.4 inline literal text is followed by spurious space
  • 2722: C++, fix id generation for var/member declarations to include namespaces.
  • latex, images (from image directive) in lists or quoted blocks did not obey indentation (fixed together with 2671)
  • 2733: since Sphinx-1.4.4 make latexpdf generates lots of hyperref warnings
  • 2731: sphinx.ext.autodoc does not access propertymethods which raises any exceptions
  • 2666: C++, properly look up nested names involving constructors.
  • 2579: Could not refer a label including both spaces and colons via sphinx.ext.intersphinx
  • 2718: Sphinx crashes if the document file is not readable
  • 2699: hyperlinks in help HTMLs are broken if html_file_suffix is set
  • 2723: extra spaces in latex pdf output from multirow cell
  • 2735: latexpdf Underfull \hbox (badness 10000) warnings from title page
  • 2667: latex crashes if resized images appeared in section title
  • 2763: (html) Provide default value for required alt attribute for image tags of SVG source, required to validate and now consistent w/ other formats.

1.4.4

=====================================

Bugs fixed

  • 2630: Latex sphinx.sty Notice Enviroment formatting problem
  • 2632: Warning directives fail in quote environment latex build
  • 2633: Sphinx crashes with old styled indices
  • Fix a \begin{\minipage} typo in sphinx.sty from 1.4.2 (ref: 68becb1)
  • 2622: Latex produces empty pages after title and table of contents
  • 2640: 1.4.2 LaTeX crashes if code-block inside warning directive
  • Let LaTeX use straight quotes also in inline code (ref 2627)
  • 2351: latex crashes if enumerated lists are placed on footnotes
  • 2646: latex crashes if math contains twice empty lines
  • 2480: sphinx.ext.autodoc: memory addresses were shown
  • latex: allow code-blocks appearing inside lists and quotes at maximal nesting depth (ref 777, 2624, 2651)
  • 2635: Latex code directives produce inconsistent frames based on viewing resolution
  • 2639: Sphinx now bundles iftex.sty
  • Failed to build PDF with framed.sty 0.95
  • Sphinx now bundles needspace.sty

1.4.3

====================================

Bugs fixed

  • 2530: got "Counter too large" error on building PDF if large numbered footnotes existed in admonitions
  • width option of figure directive does not work if align option specified at same time (ref: 2595)
  • 2590: The inputenc package breaks compiling under lualatex and xelatex
  • 2540: date on latex front page use different font
  • Suppress "document isn't included in any toctree" warning if the document is included (ref: 2603)
  • 2614: Some tables in PDF output will end up shifted if user sets non zero \parindent in preamble
  • 2602: URL redirection breaks the hyperlinks generated by sphinx.ext.intersphinx
  • 2613: Show warnings if merged extensions are loaded
  • 2619: make sure amstext LaTeX package always loaded (ref: d657225, 488ee52, 9d82cad and 2615)
  • 2593: latex crashes if any figures in the table

1.4.2

=====================================

Features added

  • Now :confval:suppress_warnings accepts following configurations (ref: 2451, 2466):
  • app.add_node
  • app.add_directive
  • app.add_role
  • app.add_generic_role
  • app.add_source_parser
  • image.data_uri
  • image.nonlocal_uri
  • 2453: LaTeX writer allows page breaks in topic contents; and their horizontal extent now fits in the line width (with shadow in margin). Also warning-type admonitions allow page breaks and their vertical spacing has been made more coherent with the one for hint-type notices (ref 2446).
  • 2459: the framing of literal code-blocks in LaTeX output (and not only the code lines themselves) obey the indentation in lists or quoted blocks.
  • 2343: the long source lines in code-blocks are wrapped (without modifying the line numbering) in LaTeX output (ref 1534, 2304).

Bugs fixed

  • 2370: the equations are slightly misaligned in LaTeX writer
  • 1817, 2077: suppress pep8 warnings on conf.py generated by sphinx-quickstart
  • 2407: building docs crash if document includes large data image URIs
  • 2436: Sphinx does not check version by :confval:needs_sphinx if loading extensions failed
  • 2397: Setup shorthandoff for turkish documents
  • 2447: VerbatimBorderColor wrongly used also for captions of PDF
  • 2456: C++, fix crash related to document merging (e.g., singlehtml and Latex builders).
  • 2446: latex(pdf) sets local tables of contents (or more generally topic nodes) in unbreakable boxes, causes overflow at bottom
  • 2476: Omit MathJax markers if :nowrap: is given
  • 2465: latex builder fails in case no caption option is provided to toctree directive
  • Sphinx crashes if self referenced toctree found
  • 2481: spelling mistake for mecab search splitter. Thanks to Naoki Sato.
  • 2309: Fix could not refer "indirect hyperlink targets" by ref-role
  • intersphinx fails if mapping URL contains any port
  • 2088: intersphinx crashes if the mapping URL requires basic auth
  • 2304: auto line breaks in latexpdf codeblocks
  • 1534: Word wrap long lines in Latex verbatim blocks
  • 2460: too much white space on top of captioned literal blocks in PDF output
  • Show error reason when multiple math extensions are loaded (ref: 2499)
  • 2483: any figure number was not assigned if figure title contains only non text objects
  • 2501: Unicode subscript numbers are normalized in LaTeX
  • 2492: Figure directive with :figwidth: generates incorrect Latex-code
  • The caption of figure is always put on center even if :align: was specified
  • 2526: LaTeX writer crashes if the section having only images
  • 2522: Sphinx touches mo files under installed directory that caused permission error.
  • 2536: C++, fix crash when an immediately nested scope has the same name as the current scope.
  • 2555: Fix crash on any-references with unicode.
  • 2517: wrong bookmark encoding in PDF if using LuaLaTeX
  • 2521: generated Makefile causes BSD make crashed if sphinx-build not found
  • 2470: typing backport package causes autodoc errors with python 2.7
  • sphinx.ext.intersphinx crashes if non-string value is used for key of intersphinx_mapping
  • 2518: intersphinx_mapping disallows non alphanumeric keys
  • 2558: unpack error on devhelp builder
  • 2561: Info builder crashes when a footnote contains a link
  • 2565: The descriptions of objects generated by sphinx.ext.autosummary overflow lines at LaTeX writer
  • Extend pdflatex config in sphinx.sty to subparagraphs (ref: 2551)
  • 2445: rst_prolog and rst_epilog affect to non reST sources
  • 2576: sphinx.ext.imgmath crashes if subprocess raises error
  • 2577: sphinx.ext.imgmath: Invalid argument are passed to dvisvgm
  • 2556: Xapian search does not work with Python 3
  • 2581: The search doesn't work if language="es" (spanish)
  • 2382: Adjust spacing after abbreviations on figure numbers in LaTeX writer
  • 2383: The generated footnote by latex_show_urls overflows lines
  • 2497, 2552: The label of search button does not fit for the button itself

1.4.1

=====================================

Incompatible changes

  • The default format of today_fmt and html_last_updated_fmt is back to strftime format again. Locale Date Markup Language is also supported for backward compatibility until Sphinx-1.5.

Translations

  • Added Welsh translation, thanks to Geraint Palmer.
  • Added Greek translation, thanks to Stelios Vitalis.
  • Added Esperanto translation, thanks to Dinu Gherman.
  • Added Hindi translation, thanks to Purnank H. Ghumalia.
  • Added Romanian translation, thanks to Razvan Stefanescu.

Bugs fixed

  • C++, added support for extern and thread_local.
  • C++, type declarations are now using the prefixes typedef, using, and type, depending on the style of declaration.
  • 2413: C++, fix crash on duplicate declarations
  • 2394: Sphinx crashes when html_last_updated_fmt is invalid
  • 2408: dummy builder not available in Makefile and make.bat
  • 2412: hyperlink targets are broken in LaTeX builder
  • figure directive crashes if non paragraph item is given as caption
  • 2418: time formats no longer allowed in today_fmt
  • 2395: Sphinx crashes if unicode character in image filename
  • 2396: "too many values to unpack" in genindex-single
  • 2405: numref link in PDF jumps to the wrong location
  • 2414: missing number in PDF hyperlinks to code listings
  • 2440: wrong import for gmtime. Thanks to Uwe L. Korn.

1.4

===================================

Incompatible changes

  • Drop PorterStemmer package support. Use PyStemmer instead of PorterStemmer to accelerate stemming.
  • sphinx_rtd_theme has become optional. Please install it manually. Refs 2087, 2086, 1845 and 2097. Thanks to Victor Zverovich.
  • 2231: Use DUrole instead of DUspan for custom roles in LaTeX writer. It enables to take title of roles as an argument of custom macros.
  • 2022: 'Thumbs.db' and '.DS_Store' are added to exclude_patterns default values in conf.py that will be provided on sphinx-quickstart.
  • 2027, 2208: The html_title accepts string values only. And The None value cannot be accepted.
  • sphinx.ext.graphviz: show graph image in inline by default
  • 2060, 2224: The manpage role now generate sphinx.addnodes.manpage node instead of sphinx.addnodes.literal_emphasis node.
  • 2022: :confval:html_extra_path also copies dotfiles in the extra directory, and refers to :confval:exclude_patterns to exclude extra files and directories.
  • 2300: enhance autoclass:: to use the docstring of new if init method's is missing of empty
  • 2251: Previously, under glossary directives, multiple terms for one definition are converted into single term node and the each terms in the term node are separated by termsep node. In new implementation, each terms are converted into individual term nodes and termsep node is removed. By this change, output layout of every builders are changed a bit.
  • The default highlight language is now Python 3. This means that source code is highlighted as Python 3 (which is mostly a superset of Python 2), and no parsing is attempted to distinguish valid code. To get the old behavior back, add highlight_language = &quot;python&quot; to conf.py.
  • Locale Date Markup Language &lt;http://unicode.org/reports/tr35/tr35-dates.htmlDate_Format_Patterns&gt;_ like &quot;MMMM dd, YYYY&quot; is default format for today_fmt and html_last_updated_fmt. However strftime format like &quot;%B %d, %Y&quot; is also supported for backward compatibility until Sphinx-1.5. Later format will be disabled from Sphinx-1.5.
  • 2327: latex_use_parts is deprecated now. Use latex_toplevel_sectioning instead.
  • 2337: Use \url{URL} macro instead of \href{URL}{URL} in LaTeX writer.
  • 1498: manpage writer: don't make whole of item in definition list bold if it includes strong node.
  • 582: Remove hint message from quick search box for html output.
  • 2378: Sphinx now bundles newfloat.sty

Features added

  • 2092: add todo directive support in napoleon package.
  • 1962: when adding directives, roles or nodes from an extension, warn if such an element is already present (built-in or added by another extension).
  • 1909: Add "doc" references to Intersphinx inventories.
  • C++ type alias support (e.g., .. type:: T = int).
  • C++ template support for classes, functions, type aliases, and variables (1729, 1314).
  • C++, added new scope management directives namespace-push and namespace-pop.
  • 1970: Keyboard shortcuts to navigate Next and Previous topics
  • Intersphinx: Added support for fetching Intersphinx inventories with URLs using HTTP basic auth.
  • C++, added support for template parameter in function info field lists.
  • C++, added support for pointers to member (function).
  • 2113: Allow :class: option to code-block directive.
  • 2192: Imgmath (pngmath with svg support).
  • 2200: Support XeTeX and LuaTeX for the LaTeX builder.
  • 1906: Use xcolor over color for \fcolorbox where available for LaTeX output.
  • 2216: Texinputs makefile improvements.
  • 2170: Support for Chinese language search index.
  • 2214: Add sphinx.ext.githubpages to publish the docs on GitHub Pages
  • 1030: Make page reference names for latex_show_pagerefs translatable
  • 2162: Add Sphinx.add_source_parser() to add source_suffix and source_parsers from extension
  • 2207: Add sphinx.parsers.Parser class; a base class for new parsers
  • 656: Add graphviz_dot option to graphviz directives to switch the dot command
  • 1939: Added the dummy builder: syntax check without output.
  • 2230: Add math_number_all option to number all displayed math in math extensions
  • 2235: needs_sphinx supports micro version comparison
  • 2282: Add "language" attribute to html tag in the "basic" theme
  • 1779: Add EPUB 3 builder
  • 1751: Add :confval:todo_link_only to avoid file path and line indication on :rst:dir:todolist. Thanks to Francesco Montesano.
  • 2199: Use imagesize package to obtain size of images.
  • 1099: Add configurable retries to the linkcheck builder. Thanks to Alex Gaynor. Also don't check anchors starting with !.
  • 2300: enhance autoclass:: to use the docstring of new if init method's is missing of empty
  • 1858: Add Sphinx.add_enumerable_node() to add enumerable nodes for numfig feature
  • 1286, 2099: Add sphinx.ext.autosectionlabel extension to allow reference sections using its title. Thanks to Tadhg O'Higgins.
  • 1854: Allow to choose Janome for Japanese splitter.
  • 1853: support custom text splitter on html search with language=&#39;ja&#39;.
  • 2320: classifier of glossary terms can be used for index entries grouping key. The classifier also be used for translation. See also :ref:glossary-directive.
  • 2308: Define \tablecontinued macro to redefine the style of continued label for longtables.
  • Select an image by similarity if multiple images are globbed by .. image:: filename.*
  • 1921: Support figure substitutions by :confval:language and :confval:figure_language_filename
  • 2245: Add latex_elements[&quot;passoptionstopackages&quot;] option to call PassOptionsToPackages in early stage of preambles.
  • 2340: Math extension: support alignment of multiple equations for MathJAX.
  • 2338: Define \titleref macro to redefine the style of title-reference roles.
  • Define \menuselection and \accelerator macros to redefine the style of menuselection roles.
  • Define \crossref macro to redefine the style of references
  • 2301: Texts in the classic html theme should be hyphenated.
  • 2355: Define \termref macro to redefine the style of term roles.
  • Add :confval:suppress_warnings to suppress arbitrary warning message (experimental)
  • 2229: Fix no warning is given for unknown options
  • 2327: Add latex_toplevel_sectioning to switch the top level sectioning of LaTeX document.

Bugs fixed

  • 1913: C++, fix assert bug for enumerators in next-to-global and global scope.
  • C++, fix parsing of 'signed char' and 'unsigned char' as types.
  • C++, add missing support for 'friend' functions.
  • C++, add missing support for virtual base classes (thanks to Rapptz).
  • C++, add support for final classes.
  • C++, fix parsing of types prefixed with 'enum'.
  • 2023: Dutch search support uses Danish stemming info.
  • C++, add support for user-defined literals.
  • 1804: Now html output wraps overflowed long-line-text in the sidebar. Thanks to Hassen ben tanfous.
  • 2183: Fix porterstemmer causes make json to fail.
  • 1899: Ensure list is sent to OptParse.
  • 2164: Fix wrong check for pdftex inside sphinx.sty (for graphicx package option).
  • 2165, 2218: Remove faulty and non-need conditional from sphinx.sty.
  • Fix broken LaTeX code is generated if unknown language is given
  • 1944: Fix rst_prolog breaks file-wide metadata
  • 2074: make gettext should use canonical relative paths for .pot. Thanks to anatoly techtonik.
  • 2311: Fix sphinx.ext.inheritance_diagram raises AttributeError
  • 2251: Line breaks in .rst files are transferred to .pot files in a wrong way.
  • 794: Fix date formatting in latex output is not localized
  • Remove image/gif from supported_image_types of LaTeX writer (2272)
  • Fix ValueError is raised if LANGUAGE is empty string
  • Fix unpack warning is shown when the directives generated from Sphinx.add_crossref_type is used
  • The default highlight language is now default. This means that source code is highlighted as Python 3 (which is mostly a superset of Python 2) if possible. To get the old behavior back, add highlight_language = &quot;python&quot; to conf.py.
  • 2329: Refresh environment forcely if source directory has changed.
  • 2331: Fix code-blocks are filled by block in dvi; remove xcdraw option from xcolor package
  • Fix the confval type checker emits warnings if unicode is given to confvals which expects string value
  • 2360: Fix numref in LaTeX output is broken
  • 2361: Fix additional paragraphs inside the "compound" directive are indented
  • 2364: Fix KeyError 'rootSymbol' on Sphinx upgrade from older version.
  • 2348: Move amsmath and amssymb to before fontpkg on LaTeX writer.
  • 2368: Ignore emacs lock files like .foo.rst by default.
  • 2262: literal_block and its caption has been separated by pagebreak in LaTeX output.
  • 2319: Fix table counter is overrided by code-block's in LaTeX. Thanks to jfbu.
  • Fix unpack warning if combinated with 3rd party domain extensions.
  • 1153: Fix figures in sidebar causes latex build error.
  • 2358: Fix user-preamble could not override the tocdepth definition.
  • 2358: Redece tocdepth if part or chapter is used for top_sectionlevel.
  • 2351: Fix footnote spacing
  • 2363: Fix toctree() in templates generates broken links in SingleHTMLBuilder.
  • 2366: Fix empty hyperref is generated on toctree in HTML builder.

Documentation

  • 1757: Fix for usage of :confval:html_last_updated_fmt. Thanks to Ralf Hemmecke.

1.3.6

=====================================

Features added

  • 1873, 1876, 2278: Add page_source_suffix html context variable. This should be introduced with :confval:source_parsers feature. Thanks for Eric Holscher.

Bugs fixed

  • 2265: Fix babel is used in spite of disabling it on latex_elements
  • 2295: Avoid mutating dictionary errors while enumerating members in autodoc with Python 3
  • 2291: Fix pdflatex "Counter too large" error from footnotes inside tables of contents
  • 2292: Fix some footnotes disappear from LaTeX output
  • 2287: sphinx.transforms.Locale always uses rst parser. Sphinx i18n feature should support parsers that specified source_parsers.
  • 2290: Fix sphinx.ext.mathbase use of amsfonts may break user choice of math fonts
  • 2324: Print a hint how to increase the recursion limit when it is hit.
  • 1565, 2229: Revert new warning; the new warning will be triggered from version 1.4 on.
  • 2329: Refresh environment forcely if source directory has changed.
  • 2019: Fix the domain objects in search result are not escaped

1.3.5

=====================================

Bugs fixed

  • Fix line numbers was not shown on warnings in LaTeX and texinfo builders
  • Fix filenames were not shown on warnings of citations
  • Fix line numbers was not shown on warnings in LaTeX and texinfo builders
  • Fix line numbers was not shown on warnings of indices
  • 2026: Fix LaTeX builder raises error if parsed-literal includes links
  • 2243: Ignore strange docstring types for classes, do not crash
  • 2247: Fix 2205 breaks make html for definition list with classifiers that contains regular-expression like string
  • 1565: Sphinx will now emit a warning that highlighting was skipped if the syntax is incorrect for code-block, literalinclude and so on.
  • 2211: Fix paragraphs in table cell doesn't work in Latex output
  • 2253: :pyobject: option of literalinclude directive can't detect indented body block when the block starts with blank or comment lines.
  • Fix TOC is not shown when no :maxdepth: for toctrees (ref: 771)
  • Fix warning message for :numref: if target is in orphaned doc (ref: 2244)

1.3.4

=====================================

Bugs fixed

  • 2134: Fix figure caption with reference causes latex build error
  • 2094: Fix rubric with reference not working in Latex
  • 2147: Fix literalinclude code in latex does not break in pages
  • 1833: Fix email addresses is showed again if latex_show_urls is not None
  • 2176: sphinx.ext.graphviz: use <object> instead of <img> to embed svg
  • 967: Fix SVG inheritance diagram is not hyperlinked (clickable)
  • 1237: Fix footnotes not working in definition list in LaTeX
  • 2168: Fix raw directive does not work for text writer
  • 2171: Fix cannot linkcheck url with unicode
  • 2182: LaTeX: support image file names with more than 1 dots
  • 2189: Fix previous sibling link for first file in subdirectory uses last file, not intended previous from root toctree
  • 2003: Fix decode error under python2 (only) when make linkcheck is run
  • 2186: Fix LaTeX output of \mathbb in math
  • 1480, 2188: LaTeX: Support math in section titles
  • 2071: Fix same footnote in more than two section titles => LaTeX/PDF Bug
  • 2040: Fix UnicodeDecodeError in sphinx-apidoc when author contains non-ascii characters
  • 2193: Fix shutil.SameFileError if source directory and destination directory are same
  • 2178: Fix unparseable C++ cross-reference when referencing a function with :cpp:any:
  • 2206: Fix Sphinx latex doc build failed due to a footnotes
  • 2201: Fix wrong table caption for tables with over 30 rows
  • 2213: Set <blockquote> in the classic theme to fit with <p>
  • 1815: Fix linkcheck does not raise an exception if warniserror set to true and link is broken
  • 2197: Fix slightly cryptic error message for missing index.rst file
  • 1894: Unlisted phony targets in quickstart Makefile
  • 2125: Fix unifies behavior of collapsed fields (GroupedField and TypedField)
  • 1408: Check latex_logo validity before copying
  • 771: Fix latex output doesn't set tocdepth
  • 1820: On Windows, console coloring is broken with colorama version 0.3.3. Now sphinx use colorama>=0.3.5 to avoid this problem.
  • 2072: Fix footnotes in chapter-titles do not appear in PDF output
  • 1580: Fix paragraphs in longtable don't work in Latex output
  • 1366: Fix centered image not centered in latex
  • 1860: Fix man page using :samp: with braces - font doesn't reset
  • 1610: Sphinx crashes in japanese indexing in some systems
  • Fix Sphinx crashes if mecab initialization failed
  • 2160: Fix broken TOC of PDFs if section includes an image
  • 2172: Fix dysfunctional admonition \pylightbox in sphinx.sty. Thanks to jfbu.
  • 2198,2205: make gettext generate broken msgid for definition lists.
  • 2062: Escape characters in doctests are treated incorrectly with Python 2.
  • 2225: Fix if the option does not begin with dash, linking is not performed
  • 2226: Fix math is not HTML-encoded when :nowrap: is given (jsmath, mathjax)
  • 1601, 2220: 'any' role breaks extended domains behavior. Affected extensions doesn't support resolve_any_xref and resolve_xref returns problematic node instead of None. sphinxcontrib-httpdomain is one of them.
  • 2229: Fix no warning is given for unknown options

1.3.3

====================================

Bugs fixed

  • 2177: Fix parallel hangs
  • 2012: Fix exception occurred if numfig_format is invalid
  • 2142: Provide non-minified JS code in sphinx/search/non-minified-js/*.js for source distribution on PyPI.
  • 2148: Error while building devhelp target with non-ASCII document.

1.3.2

=====================================

Features added

  • 1935: Make "numfig_format" overridable in latex_elements.

Bugs fixed

  • 1976: Avoid "2.0" version of Babel because it doesn't work with Windows environment.
  • Add a "default.css" stylesheet (which imports "classic.css") for compatibility.
  • 1788: graphviz extension raises exception when caption option is present.
  • 1789: :pyobject: option of literalinclude directive includes following lines after class definitions
  • 1790: literalinclude strips empty lines at the head and tail
  • 1802: load plugin themes automatically when theme.conf use it as 'inherit'. Thanks to Takayuki Hirai.
  • 1794: custom theme extended from alabaster or sphinx_rtd_theme can't find base theme.
  • 1834: compatibility for docutils-0.13: handle_io_errors keyword argument for docutils.io.FileInput cause TypeError.
  • 1823: '.' as <module_path> for sphinx-apidoc cause an unfriendly error. Now '.' is converted to absolute path automatically.
  • Fix a crash when setting up extensions which do not support metadata.
  • 1784: Provide non-minified JS code in sphinx/search/non-minified-js/*.js
  • 1822, 1892: Fix regression for 1061. autosummary can't generate doc for imported members since sphinx-1.3b3. Thanks to Eric Larson.
  • 1793, 1819: "see also" misses a linebreak in text output. Thanks to Takayuki Hirai.
  • 1780, 1866: "make text" shows "class" keyword twice. Thanks to Takayuki Hirai.
  • 1871: Fix for LaTeX output of tables with one column and multirows.
  • Work around the lack of the HTMLParserError exception in Python 3.5.
  • 1949: Use safe_getattr in the coverage builder to avoid aborting with descriptors that have custom behavior.
  • 1915: Do not generate smart quotes in doc field type annotations.
  • 1796: On py3, automated .mo building caused UnicodeDecodeError.
  • 1923: Use babel features only if the babel latex element is nonempty.
  • 1942: Fix a KeyError in websupport.
  • 1903: Fix strange id generation for glossary terms.
  • make text will crush if a definition list item has more than 1 classifiers as: term : classifier1 : classifier2.
  • 1855: make gettext generates broken po file for definition lists with classifier.
  • 1869: Fix problems when dealing with files containing non-ASCII characters. Thanks to Marvin Schmidt.
  • 1798: Fix building LaTeX with references in titles.
  • 1725: On py2 environment, doctest with using non-ASCII characters causes &#39;ascii&#39; codec can&#39;t decode byte exception.
  • 1540: Fix RuntimeError with circular referenced toctree
  • 1983: i18n translation feature breaks references which uses section name.
  • 1990: Use caption of toctree to title of \tableofcontents in LaTeX
  • 1987: Fix ampersand is ignored in :menuselection: and :guilabel: on LaTeX builder
  • 1994: More supporting non-standard parser (like recommonmark parser) for Translation and WebSupport feature. Now node.rawsource is fall backed to node.astext() during docutils transforming.
  • 1989: "make blahblah" on Windows indicate help messages for sphinx-build every time. It was caused by wrong make.bat that generated by Sphinx-1.3.0/1.3.1.
  • 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.
  • 1974: UnboundLocalError: local variable 'domain' referenced before assignment when using any role and sphinx.ext.intersphinx in same time.
  • 2121: multiple words search doesn't find pages when words across on the page title and the page content.
  • 1884, 1885: plug-in html themes cannot inherit another plug-in theme. Thanks to Suzumizaki.
  • 1818: sphinx.ext.todo directive generates broken html class attribute as 'admonition-' when :confval:language is specified with non-ASCII linguistic area like 'ru' or 'ja'. To fix this, now todo directive can use :class: option.
  • 2140: Fix footnotes in table has broken in LaTeX
  • 2127: MecabBinder for html searching feature doesn't work with Python 3. Thanks to Tomoko Uchida.

1.3.1

=====================================

Bugs fixed

  • 1769: allows generating quickstart files/dirs for destination dir that doesn't overwrite existent files/dirs. Thanks to WAKAYAMA shirou.
  • 1773: sphinx-quickstart doesn't accept non-ASCII character as a option argument.
  • 1766: the message "least Python 2.6 to run" is at best misleading.
  • 1772: cross reference in docstrings like :param .write: breaks building.
  • 1770, 1774: literalinclude with empty file occurs exception. Thanks to Takayuki Hirai.
  • 1777: Sphinx 1.3 can't load extra theme. Thanks to tell-k.
  • 1776: source_suffix = [&#39;.rst&#39;] cause unfriendly error on prior version.
  • 1771: automated .mo building doesn't work properly.
  • 1783: Autodoc: Python2 Allow unicode string in all. Thanks to Jens Hedegaard Nielsen.
  • 1781: Setting html_domain_indices to a list raises a type check warnings.

1.3

===================================

Incompatible changes

  • Roles ref, term and menusel now don't generate :durole:emphasis nodes anymore. If you want to keep italic style, adapt your stylesheet.
  • Role numref uses %s as special character to indicate position of figure numbers instead ```` symbol.

Features added

  • Add convenience directives and roles to the C++ domain: directive cpp:var as alias for cpp:member, role :cpp:var as alias for :cpp:member, and role any for cross-reference to any C++ declaraction. 1577, 1744
  • The :confval:source_suffix config value can now be a list of multiple suffixes.
  • Add the ability to specify source parsers by source suffix with the :confval:source_parsers config value.
  • 1675: A new builder, AppleHelpBuilder, has been added that builds Apple Help Books.

Bugs fixed

  • 1.3b3 change breaks a previous gettext output that contains duplicated msgid such as "foo bar" and "version changes in 1.3: foo bar".
  • 1745: latex builder cause maximum recursion depth exceeded when a footnote has a footnote mark itself.
  • 1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6.
  • 1658, 1750: No link created (and warning given) if option does not begin with -, / or +. Thanks to Takayuki Hirai.
  • 1753: C++, added missing support for more complex declarations.
  • 1700: Add :caption: option for :rst:dir:toctree.
  • 1742: :name: option is provided for :rst:dir:toctree, :rst:dir:code-block and :rst:dir:literalinclude dirctives.
  • 1756: Incorrect section titles in search that was introduced from 1.3b3.
  • 1746: C++, fixed name lookup procedure, and added missing lookups in declarations.
  • 1765: C++, fix old id generation to use fully qualified names.

Documentation

  • 1651: Add vartype field descritpion for python domain.

1.3b3

=====================================

Incompatible changes

  • Dependency requirement updates: docutils 0.11, Pygments 2.0
  • The gettext_enables config value has been renamed to gettext_additional_targets.
  • 1735: Use https://docs.python.org/ instead of http protocol. It was used for sphinx.ext.intersphinx and some documentation.

Features added

  • 1346: Add new default theme;
  • Add 'alabaster' theme.
  • Add 'sphinx_rtd_theme' theme.
  • The 'default' html theme has been renamed to 'classic'. 'default' is still available, however it will emit notice a recommendation that using new 'alabaster' theme.
  • Added highlight_options configuration value.
  • The language config value is now available in the HTML templates.
  • The env-updated event can now return a value, which is interpreted as an iterable of additional docnames that need to be rewritten.
  • 772: Support for scoped and unscoped enums in C++. Enumerators in unscoped enums are injected into the parent scope in addition to the enum scope.
  • Add todo_include_todos config option to quickstart conf file, handled as described in documentation.
  • HTML breadcrumb items tag has class "nav-item" and "nav-item-N" (like nav-item-0, 1, 2...).
  • New option sphinx-quickstart --use-make-mode for generating Makefile that use sphinx-build make-mode.
  • 1235: i18n: several node can be translated if it is set to gettext_additional_targets in conf.py. Supported nodes are:
  • 'literal-block'
  • 'doctest-block'
  • 'raw'
  • 'image'
  • 1227: Add html_scaled_image_link config option to conf.py, to control scaled image link.

Bugs fixed

  • LaTeX writer now generates correct markup for cells spanning multiple rows.
  • 1674: Do not crash if a module's __all__ is not a list of strings.
  • 1629: Use VerbatimBorderColor to add frame to code-block in LaTeX
  • On windows, make-mode didn't work on Win32 platform if sphinx was invoked as python sphinx-build.py.
  • 1687: linkcheck now treats 401 Unauthorized responses as "working".
  • 1690: toctrees with glob option now can also contain entries for single documents with explicit title.
  • 1591: html search results for C++ elements now has correct interpage links.
  • bizstyle theme: nested long title pages make long breadcrumb that breaks page layout.
  • bizstyle theme: all breadcrumb items become 'Top' on some mobile browser (iPhone5s safari).
  • 1722: restore toctree() template function behavior that was changed at 1.3b1.
  • 1732: i18n: localized table caption raises exception.
  • 1718: :numref: does not work with capital letters in the label
  • 1630: resolve CSS conflicts, div.container css target for literal block wrapper now renamed to div.literal-block-wrapper.
  • sphinx.util.pycompat has been restored in its backwards-compatibility; slated for removal in Sphinx 1.4.
  • 1719: LaTeX writer does not respect numref_format option in captions

1.3b2

====================================

Incompatible changes

  • update bundled ez_setup.py for setuptools-7.0 that requires Python 2.6 or later.

Features added

  • 1597: Added possibility to return a new template name from html-page-context.
  • PR314, 1150: Configuration values are now checked for their type. A warning is raised if the configured and the default value do not have the same type and do not share a common non-trivial base class.

Bugs fixed

  • PR311: sphinx-quickstart does not work on python 3.4.
  • Fix :confval:autodoc_docstring_signature not working with signatures in class docstrings.
  • Rebuilding cause crash unexpectedly when source files were added.
  • 1607: Fix a crash when building latexpdf with "howto" class
  • 1251: Fix again. Sections which depth are lower than :tocdepth: should not be shown on localtoc sidebar.
  • make-mode didn't work on Win32 platform if sphinx was installed by wheel package.

1.3b1

=====================================

Incompatible changes

  • Dropped support for Python 2.5, 3.1 and 3.2.
  • Dropped support for docutils versions up to 0.9.
  • Removed the sphinx.ext.oldcmarkup extension.
  • The deprecated config values exclude_trees, exclude_dirnames and unused_docs have been removed.
  • A new node, sphinx.addnodes.literal_strong, has been added, for text that should appear literally (i.e. no smart quotes) in strong font. Custom writers will have to be adapted to handle this node.
  • PR269, 1476: replace &lt;tt&gt; tag by &lt;code&gt;. User customized stylesheets should be updated If the css contain some styles for tt&gt; tag. Thanks to Takeshi Komiya.
  • 1543: templates_path is automatically added to exclude_patterns to avoid reading autosummary rst templates in the templates directory.
  • Custom domains should implement the new Domain.resolve_any_xref method to make the any role work properly.
  • gettext builder: gettext doesn't emit uuid information to generated pot files by default. Please set True to gettext_uuid to emit uuid information. Additionally, if the python-levenshtein 3rd-party package is installed, it will improve the calculation time.
  • gettext builder: disable extracting/apply 'index' node by default. Please set 'index' to gettext_enables to enable extracting index entries.
  • PR307: Add frame to code-block in LaTeX. Thanks to Takeshi Komiya.

Features added

  • Add support for Python 3.4.
  • Add support for docutils 0.12
  • Added sphinx.ext.napoleon extension for NumPy and Google style docstring support.
  • Added support for parallel reading (parsing) of source files with the sphinx-build -j option. Third-party extensions will need to be checked for compatibility and may need to be adapted if they store information in the build environment object. See env-merge-info.
  • Added the any role that can be used to find a cross-reference of any type in any domain. Custom domains should implement the new Domain.resolve_any_xref method to make this work properly.
  • Exception logs now contain the last 10 messages emitted by Sphinx.
  • Added support for extension versions (a string returned by setup(), these can be shown in the traceback log files). Version requirements for extensions can be specified in projects using the new needs_extensions config value.
  • Changing the default role within a document with the :dudir:default-role directive is now supported.
  • PR214: Added stemming support for 14 languages, so that the built-in document search can now handle these. Thanks to Shibukawa Yoshiki.
  • PR296, PR303, 76: numfig feature: Assign numbers to figures, tables and code-blocks. This feature is configured with numfig, numfig_secnum_depth and numfig_format. Also numref role is available. Thanks to Takeshi Komiya.
  • PR202: Allow "." and "~" prefixed references in :param: doc fields for Python.
  • PR184: Add autodoc_mock_imports, allowing to mock imports of external modules that need not be present when autodocumenting.
  • 925: Allow list-typed config values to be provided on the command line, like -D key=val1,val2.
  • 668: Allow line numbering of code-block and literalinclude directives to start at an arbitrary line number, with a new lineno-start option.
  • PR172, PR266: The code-block and literalinclude directives now can have a caption option that shows a filename before the code in the output. Thanks to Nasimul Haque, Takeshi Komiya.
  • Prompt for the document language in sphinx-quickstart.
  • PR217: Added config values to suppress UUID and location information in generated gettext catalogs.
  • PR236, 1456: apidoc: Add a -M option to put module documentation before submodule documentation. Thanks to Wes Turner and Luc Saffre.
  • 1434: Provide non-minified JS files for jquery.js and underscore.js to clarify the source of the minified files.
  • PR252, 1291: Windows color console support. Thanks to meu31.
  • PR255: When generating latex references, also insert latex target/anchor for the ids defined on the node. Thanks to Olivier Heurtier.
  • PR229: Allow registration of other translators. Thanks to Russell Sim.
  • Add app.set_translator() API to register or override a Docutils translator class like html_translator_class.
  • PR267, 1134: add 'diff' parameter to literalinclude. Thanks to Richard Wall and WAKAYAMA shirou.
  • PR272: Added 'bizstyle' theme. Thanks to Shoji KUMAGAI.
  • Automatically compile *.mo files from *.po files when gettext_auto_build is True (default) and *.po is newer than *.mo file.
  • 623: sphinx.ext.viewcode supports imported function/class aliases.
  • PR275: sphinx.ext.intersphinx supports multiple target for the inventory. Thanks to Brigitta Sipocz.
  • PR261: Added the env-before-read-docs event that can be connected to modify the order of documents before they are read by the environment.
  • 1284: Program options documented with :rst:dir:option can now start with +.
  • PR291: The caption of :rst:dir:code-block is recognised as a title of ref target. Thanks to Takeshi Komiya.
  • PR298: Add new API: :meth:~sphinx.application.Sphinx.add_latex_package. Thanks to Takeshi Komiya.
  • 1344: add gettext_enables to enable extracting 'index' to gettext catalog output / applying translation catalog to generated documentation.
  • PR301, 1583: Allow the line numbering of the directive literalinclude to match that of the included file, using a new lineno-match option. Thanks to Jeppe Pihl.
  • PR299: add various options to sphinx-quickstart. Quiet mode option --quiet will skips wizard mode. Thanks to WAKAYAMA shirou.
  • 1623: Return types specified with :rtype: are now turned into links if possible.

Bugs fixed

  • 1438: Updated jQuery version from 1.8.3 to 1.11.1.
  • 1568: Fix a crash when a "centered" directive contains a reference.
  • Now sphinx.ext.autodoc works with python-2.5 again.
  • 1563: :meth:~sphinx.application.Sphinx.add_search_language raises AssertionError for correct type of argument. Thanks to rikoman.
  • 1174: Fix smart quotes being applied inside roles like :rst:role:program or makevar.
  • PR235: comment db schema of websupport lacked a length of the node_id field. Thanks to solos.
  • 1466,PR241: Fix failure of the cpp domain parser to parse C+11 "variadic templates" declarations. Thanks to Victor Zverovich.
  • 1459,PR244: Fix default mathjax js path point to http:// that cause mixed-content error on HTTPS server. Thanks to sbrandtb and robo9k.
  • PR157: autodoc remove spurious signatures from property decorated attributes. Thanks to David Ham.
  • PR159: Add coverage targets to quickstart generated Makefile and make.bat. Thanks to Matthias Troffaes.
  • 1251: When specifying toctree :numbered: option and :tocdepth: metadata, sub section number that is larger depth than :tocdepth: is shrunk.
  • PR260: Encode underscore in citation labels for latex export. Thanks to Lennart Fricke.
  • PR264: Fix could not resolve xref for figure node with :name: option. Thanks to Takeshi Komiya.
  • PR265: Fix could not capture caption of graphviz node by xref. Thanks to Takeshi Komiya.
  • PR263, 1013, 1103: Rewrite of C++ domain. Thanks to Jakob Lykke Andersen.
  • Hyperlinks to all found nested names and template arguments (1103).
  • Support for function types everywhere, e.g., in std::function<bool(int, int)> (1013).
  • Support for virtual functions.
  • Changed interpretation of function arguments to following standard prototype declarations, i.e., void f(arg) means that arg is the type of the argument, instead of it being the name.
  • Updated tests.
  • Updated documentation with elaborate description of what declarations are supported and how the namespace declarations influence declaration and cross-reference lookup.
  • Index names may be different now. Elements are indexed by their fully qualified name. It should be rather easy to change this behaviour and potentially index by namespaces/classes as well.
  • PR258, 939: Add dedent option for code-block and literalinclude. Thanks to Zafar Siddiqui.
  • PR268: Fix numbering section does not work at singlehtml mode. It still ad-hoc fix because there is a issue that section IDs are conflicted. Thanks to Takeshi Komiya.
  • PR273, 1536: Fix RuntimeError with numbered circular toctree. Thanks to Takeshi Komiya.
  • PR274: Set its URL as a default title value if URL appears in toctree. Thanks to Takeshi Komiya.
  • PR276, 1381: rfc and pep roles support custom link text. Thanks to Takeshi Komiya.
  • PR277, 1513: highlights for function pointers in argument list of c:function. Thanks to Takeshi Komiya.
  • PR278: Fix section entries were shown twice if toctree has been put under only directive. Thanks to Ta

Merge request reports