2016-03-06 07:17:27 -06:00
Release 1.5 (in development)
============================
Incompatible changes
--------------------
2016-04-20 11:58:58 -05:00
* LaTeX package fancybox is not longer a dependency of sphinx.sty
2016-04-24 20:39:25 -05:00
* Use ``'locales'`` as a default value of `locale_dirs`
2016-04-20 11:58:58 -05:00
2016-03-06 07:17:27 -06:00
Features added
--------------
2016-03-10 22:20:05 -06:00
* Add ``:caption:`` option for sphinx.ext.inheritance_diagram.
2016-04-20 10:58:26 -05:00
* #894: Add ``lualatexpdf`` and ``xelatexpdf`` as a make target to build PDF using lualatex or xelatex
2016-04-21 03:43:41 -05:00
* #2471: Add config variable for default doctest flags.
2016-03-10 22:20:05 -06:00
2016-03-06 07:17:27 -06:00
Bugs fixed
----------
Documentation
-------------
2016-04-12 08:20:08 -05:00
Release 1.4.2 (in development)
2016-03-28 08:05:43 -05:00
==============================
2016-02-14 07:42:59 -06:00
2016-04-14 21:44:12 -05:00
Features added
--------------
* Now :confval:`suppress_warnings` accepts following configurations: ``app.add_node``, ``app.add_directive``, ``app.add_role`` and ``app.add_generic_role`` (ref: #2451)
2016-04-20 05:49:43 -05:00
* LaTeX writer allows page breaks in topic contents; and their horizontal
extent now fits in the line width (shadow in margin). Warning-type
admonitions allow page breaks (if very long) and their vertical spacing
has been made more coherent with the one for Hint-type notices.
2016-04-21 07:18:37 -05:00
* Convert linkcheck builder to requests for better encoding handling
2016-04-14 21:44:12 -05:00
2016-04-12 08:20:08 -05:00
Bugs fixed
----------
2016-04-13 10:00:36 -05:00
* #2370: the equations are slightly misaligned in LaTeX writer
2016-04-14 11:52:13 -05:00
* #1817, #2077: suppress pep8 warnings on conf.py generated by sphinx-quickstart
2016-04-16 01:04:32 -05:00
* #2407: building docs crash if document includes large data image URIs
2016-04-16 02:55:59 -05:00
* #2436: Sphinx does not check version by :confval:`needs_sphinx` if loading extensions failed
2016-04-16 04:28:15 -05:00
* #2397: Setup shorthandoff for turkish documents
2016-04-16 09:28:02 -05:00
* #2447: VerbatimBorderColor wrongly used also for captions of PDF
2016-04-19 03:33:52 -05:00
* #2456: C++, fix crash related to document merging (e.g., singlehtml and Latex builders).
2016-04-20 05:49:43 -05:00
* #2446: latex(pdf) sets local tables of contents (or more generally topic nodes) in unbreakable boxes, causes overflow at bottom
2016-04-13 10:00:36 -05:00
2016-04-12 08:20:08 -05:00
2016-04-12 08:12:19 -05:00
Release 1.4.1 (released Apr 12, 2016)
=====================================
2016-03-28 08:05:43 -05:00
2016-04-01 20:23:13 -05:00
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.
2016-03-28 08:39:59 -05:00
Translations
------------
2016-03-30 20:37:51 -05:00
* 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.
2016-03-28 08:39:59 -05:00
2016-02-14 07:42:59 -06:00
Bugs fixed
----------
2016-03-30 20:37:51 -05:00
* C++, added support for ``extern`` and ``thread_local``.
* C++, type declarations are now using the prefixes ``typedef``, ``using``, and ``type``,
2016-03-30 02:55:02 -05:00
depending on the style of declaration.
2016-04-06 00:35:15 -05:00
* #2413: C++, fix crash on duplicate declarations
2016-04-12 08:05:25 -05:00
* #2394: Sphinx crashes when html_last_updated_fmt is invalid
2016-04-02 08:27:41 -05:00
* #2408: dummy builder not available in Makefile and make.bat
2016-04-12 08:05:25 -05:00
* #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.
2016-03-30 02:19:03 -05:00
2016-02-14 07:42:59 -06:00
2016-03-28 07:51:00 -05:00
Release 1.4 (released Mar 28, 2016)
===================================
2015-03-13 23:30:08 -05:00
Incompatible changes
--------------------
2015-12-25 20:17:04 -06:00
* Drop ``PorterStemmer`` package support. Use ``PyStemmer`` instead of ``PorterStemmer``
to accelerate stemming.
2016-01-18 03:18:46 -06:00
* sphinx_rtd_theme has become optional. Please install it manually.
2016-01-14 21:02:02 -06:00
Refs #2087, #2086, #1845 and #2097. Thanks to Victor Zverovich.
2016-01-15 11:12:17 -06:00
* #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.
2016-01-17 02:02:50 -06:00
* #2022: 'Thumbs.db' and '.DS_Store' are added to `exclude_patterns` default values in
conf.py that will be provided on sphinx-quickstart.
2016-01-17 04:07:11 -06:00
* #2027, #2208: The ``html_title`` accepts string values only. And The None value cannot be
accepted.
2016-01-06 06:56:21 -06:00
* ``sphinx.ext.graphviz``: show graph image in inline by default
2016-01-17 05:05:51 -06:00
* #2060, #2224: The ``manpage`` role now generate ``sphinx.addnodes.manpage`` node instead
2016-01-18 03:49:37 -06:00
of ``sphinx.addnodes.literal_emphasis`` node.
2016-01-15 05:44:03 -06:00
* #2022: :confval:`html_extra_path` also copies dotfiles in the extra directory, and
refers to :confval:`exclude_patterns` to exclude extra files and directories.
2016-02-13 23:47:04 -06:00
* #2300: enhance autoclass:: to use the docstring of __new__ if __init__ method's is missing
of empty
2016-02-13 21:02:57 -06:00
* #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.
2016-02-14 02:21:35 -06:00
* 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
2016-02-15 16:36:53 -06:00
parsing is attempted to distinguish valid code. To get the old behavior back,
add ``highlight_language = "python"`` to conf.py.
2016-02-14 05:07:28 -06:00
* `Locale Date Markup Language
<http://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns>`_ like
``"MMMM dd, YYYY"`` is default format for `today_fmt` and `html_last_updated_fmt`.
However strftime format like ``"%B %d, %Y"`` is also supported for backward
compatibility until Sphinx-1.5. Later format will be disabled from Sphinx-1.5.
2016-03-28 07:51:00 -05:00
* #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
2015-03-13 23:30:08 -05:00
Features added
--------------
2016-01-06 03:37:30 -06:00
* #2092: add todo directive support in napoleon package.
2015-07-21 05:42:13 -05:00
* #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).
2015-07-25 05:11:23 -05:00
* #1909: Add "doc" references to Intersphinx inventories.
2016-01-06 03:37:30 -06:00
* C++ type alias support (e.g., ``.. type:: T = int``).
2015-09-05 07:49:14 -05:00
* C++ template support for classes, functions, type aliases, and variables (#1729, #1314).
2015-09-06 15:28:55 -05:00
* C++, added new scope management directives ``namespace-push`` and ``namespace-pop``.
2015-10-04 12:44:17 -05:00
* #1970: Keyboard shortcuts to navigate Next and Previous topics
2015-10-15 16:37:55 -05:00
* Intersphinx: Added support for fetching Intersphinx inventories with URLs
2016-01-06 03:37:30 -06:00
using HTTP basic auth.
2015-11-21 09:51:17 -06:00
* C++, added support for template parameter in function info field lists.
2015-12-02 13:00:28 -06:00
* C++, added support for pointers to member (function).
2016-01-06 03:37:30 -06:00
* #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.
2016-01-06 07:38:11 -06:00
* #2214: Add sphinx.ext.githubpages to publish the docs on GitHub Pages
2016-01-15 23:32:23 -06:00
* #1030: Make page reference names for latex_show_pagerefs translatable
2016-01-17 04:08:42 -06:00
* #2162: Add Sphinx.add_source_parser() to add source_suffix and source_parsers from extension
2016-01-17 04:19:29 -06:00
* #2207: Add sphinx.parsers.Parser class; a base class for new parsers
2016-01-18 08:56:05 -06:00
* #656: Add ``graphviz_dot`` option to graphviz directives to switch the ``dot`` command
2016-01-19 19:37:05 -06:00
* #1939: Added the ``dummy`` builder: syntax check without output.
2016-01-19 19:38:13 -06:00
* #2230: Add ``math_number_all`` option to number all displayed math in math extensions
2016-01-20 22:51:17 -06:00
* #2235: ``needs_sphinx`` supports micro version comparison
2016-02-06 23:49:22 -06:00
* #2282: Add "language" attribute to html tag in the "basic" theme
2016-02-07 05:10:40 -06:00
* #1779: Add EPUB 3 builder
2016-02-08 08:31:02 -06:00
* #1751: Add :confval:`todo_link_only` to avoid file path and line indication on
2016-02-09 02:38:07 -06:00
:rst:dir:`todolist`. Thanks to Francesco Montesano.
2016-02-13 09:06:55 -06:00
* #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 ``!``.
2016-02-13 23:47:04 -06:00
* #2300: enhance autoclass:: to use the docstring of __new__ if __init__ method's is missing
of empty
2016-02-13 06:22:21 -06:00
* #1858: Add Sphinx.add_enumerable_node() to add enumerable nodes for numfig feature
2016-02-14 01:07:32 -06:00
* #1286, #2099: Add ``sphinx.ext.autosectionlabel`` extension to allow reference
sections using its title. Thanks to Tadhg O'Higgins.
2016-02-14 01:48:30 -06:00
* #1854: Allow to choose Janome for Japanese splitter.
2016-02-14 06:13:31 -06:00
* #1853: support custom text splitter on html search with ``language='ja'``.
2016-02-13 07:30:06 -06:00
* #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`.
2016-03-28 07:51:00 -05:00
* #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["passoptionstopackages"]`` 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.
2015-06-26 04:52:45 -05:00
2015-03-13 23:30:08 -05:00
Bugs fixed
----------
2015-12-05 22:40:11 -06:00
* #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'.
2016-01-06 03:37:30 -06:00
* #2023: Dutch search support uses Danish stemming info.
2015-12-05 22:40:11 -06:00
* C++, add support for user-defined literals.
2015-12-09 02:29:04 -06:00
* #1804: Now html output wraps overflowed long-line-text in the sidebar. Thanks to
Hassen ben tanfous.
2016-01-06 03:37:30 -06:00
* #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.
2016-01-15 20:29:31 -06:00
* Fix broken LaTeX code is generated if unknown language is given
2016-01-24 02:32:12 -06:00
* #1944: Fix rst_prolog breaks file-wide metadata
2016-02-09 02:38:07 -06:00
* #2074: make gettext should use canonical relative paths for .pot. Thanks to
anatoly techtonik.
2016-02-14 00:07:39 -06:00
* #2311: Fix sphinx.ext.inheritance_diagram raises AttributeError
2016-02-13 02:51:44 -06:00
* #2251: Line breaks in .rst files are transferred to .pot files in a wrong way.
2016-02-14 05:07:28 -06:00
* #794: Fix date formatting in latex output is not localized
2016-03-28 07:51:00 -05:00
* 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 = "python"`` 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.
2016-03-01 21:21:18 -06:00
* #2358: Fix user-preamble could not override the tocdepth definition.
* #2358: Redece tocdepth if ``part`` or ``chapter`` is used for top_sectionlevel.
2016-03-01 21:22:05 -06:00
* #2351: Fix footnote spacing
2016-03-03 09:14:10 -06:00
* #2363: Fix ``toctree()`` in templates generates broken links in SingleHTMLBuilder.
2016-03-06 01:11:04 -06:00
* #2366: Fix empty hyperref is generated on toctree in HTML builder.
2015-12-05 22:42:26 -06:00
Documentation
-------------
2015-12-09 02:00:40 -06:00
* #1757: Fix for usage of :confval:`html_last_updated_fmt`. Thanks to Ralf Hemmecke.
2015-12-05 22:42:26 -06:00
2016-02-29 07:47:46 -06:00
Release 1.3.6 (released Feb 29, 2016)
=====================================
2016-01-23 22:10:31 -06:00
2016-02-09 03:09:43 -06:00
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.
2015-12-05 22:42:26 -06:00
Bugs fixed
----------
2016-01-27 04:38:57 -06:00
* #2265: Fix babel is used in spite of disabling it on ``latex_elements``
2016-02-04 12:58:21 -06:00
* #2295: Avoid mutating dictionary errors while enumerating members in autodoc
with Python 3
2016-02-07 04:34:40 -06:00
* #2291: Fix pdflatex "Counter too large" error from footnotes inside tables of contents
2016-02-07 07:58:14 -06:00
* #2292: Fix some footnotes disappear from LaTeX output
2016-02-02 17:57:54 -06:00
* #2287: ``sphinx.transforms.Locale`` always uses rst parser. Sphinx i18n feature should
support parsers that specified source_parsers.
2016-02-15 02:36:51 -06:00
* #2290: Fix ``sphinx.ext.mathbase`` use of amsfonts may break user choice of math fonts
2016-02-16 12:19:54 -06:00
* #2324: Print a hint how to increase the recursion limit when it is hit.
2016-02-20 04:43:39 -06:00
* #1565, #2229: Revert new warning; the new warning will be triggered from version 1.4 on.
2016-02-20 02:11:33 -06:00
* #2329: Refresh environment forcely if source directory has changed.
2016-02-28 19:52:15 -06:00
* #2019: Fix the domain objects in search result are not escaped
2016-01-23 22:10:31 -06:00
2016-01-23 21:30:49 -06:00
Release 1.3.5 (released Jan 24, 2016)
=====================================
2016-01-12 09:10:58 -06:00
Bugs fixed
----------
2016-01-11 19:50:02 -06:00
* Fix line numbers was not shown on warnings in LaTeX and texinfo builders
2016-01-11 21:03:13 -06:00
* Fix filenames were not shown on warnings of citations
2016-01-12 02:27:05 -06:00
* Fix line numbers was not shown on warnings in LaTeX and texinfo builders
2016-01-23 22:11:51 -06:00
* Fix line numbers was not shown on warnings of indices
* #2026: Fix LaTeX builder raises error if parsed-literal includes links
2016-01-17 02:08:29 -06:00
* #2243: Ignore strange docstring types for classes, do not crash
2016-01-17 20:31:48 -06:00
* #2247: Fix #2205 breaks make html for definition list with classifiers
that contains regular-expression like string
2016-01-25 19:55:47 -06:00
* #1565: Sphinx will now emit a warning that highlighting was skipped if the syntax
is incorrect for `code-block`, `literalinclude` and so on.
2016-01-19 19:39:56 -06:00
* #2211: Fix paragraphs in table cell doesn't work in Latex output
2016-01-20 07:48:16 -06:00
* #2253: ``:pyobject:`` option of ``literalinclude`` directive can't detect indented
body block when the block starts with blank or comment lines.
2016-01-20 20:32:25 -06:00
* Fix TOC is not shown when no ``:maxdepth:`` for toctrees (ref: #771)
2016-01-23 06:51:52 -06:00
* Fix warning message for ``:numref:`` if target is in orphaned doc (ref: #2244)
2016-01-12 09:10:58 -06:00
2016-01-12 08:57:44 -06:00
Release 1.3.4 (released Jan 12, 2016)
=====================================
2015-12-02 03:37:34 -06:00
Bugs fixed
----------
2015-12-05 22:42:26 -06:00
* #2134: Fix figure caption with reference causes latex build error
* #2094: Fix rubric with reference not working in Latex
2015-12-18 14:42:55 -06:00
* #2147: Fix literalinclude code in latex does not break in pages
2015-12-19 00:12:44 -06:00
* #1833: Fix email addresses is showed again if latex_show_urls is not None
2015-12-19 00:20:55 -06:00
* #2176: sphinx.ext.graphviz: use <object> instead of <img> to embed svg
2015-12-19 01:12:26 -06:00
* #967: Fix SVG inheritance diagram is not hyperlinked (clickable)
2015-12-07 21:16:15 -06:00
* #1237: Fix footnotes not working in definition list in LaTeX
2015-12-19 05:33:43 -06:00
* #2168: Fix raw directive does not work for text writer
2015-12-19 07:58:53 -06:00
* #2171: Fix cannot linkcheck url with unicode
2015-12-19 14:51:52 -06:00
* #2182: LaTeX: support image file names with more than 1 dots
2016-01-05 16:28:19 -06:00
* #2189: Fix previous sibling link for first file in subdirectory uses last file, not
intended previous from root toctree
2015-12-21 07:34:04 -06:00
* #2003: Fix decode error under python2 (only) when ``make linkcheck`` is run
2015-12-21 19:29:27 -06:00
* #2186: Fix LaTeX output of \mathbb in math
2015-12-21 20:35:30 -06:00
* #1480, #2188: LaTeX: Support math in section titles
2015-12-24 19:43:41 -06:00
* #2071: Fix same footnote in more than two section titles => LaTeX/PDF Bug
2015-12-25 00:52:51 -06:00
* #2040: Fix UnicodeDecodeError in sphinx-apidoc when author contains non-ascii characters
2015-12-25 10:44:40 -06:00
* #2193: Fix shutil.SameFileError if source directory and destination directory are same
2015-12-27 01:29:07 -06:00
* #2178: Fix unparseable C++ cross-reference when referencing a function with :cpp:any:
2016-01-01 02:28:22 -06:00
* #2206: Fix Sphinx latex doc build failed due to a footnotes
2016-01-01 04:31:36 -06:00
* #2201: Fix wrong table caption for tables with over 30 rows
2016-01-01 20:42:06 -06:00
* #2213: Set <blockquote> in the classic theme to fit with <p>
2016-01-05 16:28:19 -06:00
* #1815: Fix linkcheck does not raise an exception if warniserror set to true and link is
broken
2016-01-03 05:26:38 -06:00
* #2197: Fix slightly cryptic error message for missing index.rst file
2016-01-03 20:19:50 -06:00
* #1894: Unlisted phony targets in quickstart Makefile
2016-01-05 01:47:52 -06:00
* #2125: Fix unifies behavior of collapsed fields (``GroupedField`` and ``TypedField``)
2016-01-05 01:48:22 -06:00
* #1408: Check latex_logo validity before copying
2016-01-05 10:34:29 -06:00
* #771: Fix latex output doesn't set tocdepth
2016-01-05 16:27:34 -06:00
* #1820: On Windows, console coloring is broken with colorama version 0.3.3.
Now sphinx use colorama>=0.3.5 to avoid this problem.
2016-01-05 20:13:30 -06:00
* #2072: Fix footnotes in chapter-titles do not appear in PDF output
2016-01-06 23:15:34 -06:00
* #1580: Fix paragraphs in longtable don't work in Latex output
2016-01-07 02:08:54 -06:00
* #1366: Fix centered image not centered in latex
2016-01-07 09:37:33 -06:00
* #1860: Fix man page using ``:samp:`` with braces - font doesn't reset
2016-01-08 06:36:42 -06:00
* #1610: Sphinx crashes in japanese indexing in some systems
* Fix Sphinx crashes if mecab initialization failed
2016-01-08 06:41:52 -06:00
* #2160: Fix broken TOC of PDFs if section includes an image
2016-01-08 18:49:11 -06:00
* #2172: Fix dysfunctional admonition \py@lightbox in sphinx.sty. Thanks to jfbu.
2016-01-09 00:33:43 -06:00
* #2198,#2205: ``make gettext`` generate broken msgid for definition lists.
2016-01-09 02:22:30 -06:00
* #2062: Escape characters in doctests are treated incorrectly with Python 2.
2016-01-09 04:56:07 -06:00
* #2225: Fix if the option does not begin with dash, linking is not performed
2016-01-09 11:20:39 -06:00
* #2226: Fix math is not HTML-encoded when :nowrap: is given (jsmath, mathjax)
2016-01-10 08:27:11 -06:00
* #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.
2016-01-11 08:01:17 -06:00
* #2229: Fix no warning is given for unknown options
2015-12-05 22:42:26 -06:00
Release 1.3.3 (released Dec 2, 2015)
====================================
Bugs fixed
----------
2015-12-16 09:10:52 -06:00
* #2177: Fix parallel hangs
2015-12-05 22:40:11 -06:00
* #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.
Release 1.3.2 (released Nov 29, 2015)
=====================================
Features added
--------------
* #1935: Make "numfig_format" overridable in latex_elements.
Bugs fixed
----------
2015-09-12 19:37:41 -05:00
* #1976: Avoid "2.0" version of Babel because it doesn't work with Windows environment.
2015-05-18 07:50:12 -05:00
* Add a "default.css" stylesheet (which imports "classic.css") for compatibility.
2015-03-20 21:53:24 -05:00
* #1788: graphviz extension raises exception when caption option is present.
2015-03-28 20:31:26 -05:00
* #1789: ``:pyobject:`` option of ``literalinclude`` directive includes following
2015-12-05 22:40:11 -06:00
lines after class definitions
* #1790: ``literalinclude`` strips empty lines at the head and tail
2015-04-05 01:10:49 -05:00
* #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.
2015-04-05 04:22:15 -05:00
* #1834: compatibility for docutils-0.13: handle_io_errors keyword argument for
docutils.io.FileInput cause TypeError.
2015-04-05 05:05:26 -05:00
* #1823: '.' as <module_path> for sphinx-apidoc cause an unfriendly error. Now '.'
is converted to absolute path automatically.
2015-05-18 07:50:12 -05:00
* Fix a crash when setting up extensions which do not support metadata.
2015-11-10 03:02:05 -06:00
* #1784: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js``
2015-07-05 19:50:29 -05:00
* #1822, #1892: Fix regression for #1061. autosummary can't generate doc for imported
members since sphinx-1.3b3. Thanks to Eric Larson.
2015-07-11 01:22:03 -05:00
* #1793, #1819: "see also" misses a linebreak in text output. Thanks to Takayuki Hirai.
2015-07-24 09:34:11 -05:00
* #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.
2015-07-25 02:32:52 -05:00
* #1949: Use ``safe_getattr`` in the coverage builder to avoid aborting with
descriptors that have custom behavior.
2015-07-25 05:35:52 -05:00
* #1915: Do not generate smart quotes in doc field type annotations.
2015-07-25 09:51:45 -05:00
* #1796: On py3, automated .mo building caused UnicodeDecodeError.
* #1923: Use babel features only if the babel latex element is nonempty.
2015-07-25 09:54:51 -05:00
* #1942: Fix a KeyError in websupport.
2015-07-25 10:12:30 -05:00
* #1903: Fix strange id generation for glossary terms.
2015-07-25 10:37:21 -05:00
* ``make text`` will crush if a definition list item has more than 1 classifiers as:
2015-07-25 10:30:13 -05:00
``term : classifier1 : classifier2``.
2015-07-25 10:37:21 -05:00
* #1855: make gettext generates broken po file for definition lists with classifier.
2015-07-25 12:02:47 -05:00
* #1869: Fix problems when dealing with files containing non-ASCII characters. Thanks to
Marvin Schmidt.
2015-07-25 12:02:09 -05:00
* #1798: Fix building LaTeX with references in titles.
2015-08-01 10:07:23 -05:00
* #1725: On py2 environment, doctest with using non-ASCII characters causes
``'ascii' codec can't decode byte`` exception.
2015-08-09 07:08:14 -05:00
* #1540: Fix RuntimeError with circular referenced toctree
2015-08-09 09:41:47 -05:00
* #1983: i18n translation feature breaks references which uses section name.
2015-08-21 00:29:01 -05:00
* #1990: Use caption of toctree to title of \tableofcontents in LaTeX
2015-08-31 10:28:33 -05:00
* #1987: Fix ampersand is ignored in ``:menuselection:`` and ``:guilabel:`` on LaTeX builder
2015-08-16 05:20:45 -05:00
* #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.
2015-12-09 03:29:46 -06:00
* #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.
2015-10-25 10:10:36 -05:00
* On Py2 environment, conf.py that is generated by sphinx-quickstart should have u prefixed
config value for 'version' and 'release'.
2015-10-26 10:16:18 -05:00
* #2102: On Windows + Py3, using ``|today|`` and non-ASCII date format will raise
UnicodeEncodeError.
2015-11-16 09:59:39 -06:00
* #1974: UnboundLocalError: local variable 'domain' referenced before assignment when
using `any` role and `sphinx.ext.intersphinx` in same time.
2015-11-21 02:00:55 -06:00
* #2121: multiple words search doesn't find pages when words across on the page title and
the page content.
2015-11-21 09:13:42 -06:00
* #1884, #1885: plug-in html themes cannot inherit another plug-in theme. Thanks to
Suzumizaki.
2015-11-28 21:02:02 -06:00
* #1818: `sphinx.ext.todo` directive generates broken html class attribute as
'admonition-' when :confval:`language` is specified with non-ASCII linguistic area like
2016-01-12 07:48:56 -06:00
'ru' or 'ja'. To fix this, now ``todo`` directive can use ``:class:`` option.
2015-11-29 07:03:48 -06:00
* #2140: Fix footnotes in table has broken in LaTeX
2015-11-29 07:14:40 -06:00
* #2127: MecabBinder for html searching feature doesn't work with Python 3.
Thanks to Tomoko Uchida.
2015-03-13 23:30:08 -05:00
2015-03-17 00:30:11 -05:00
Release 1.3.1 (released Mar 17, 2015)
=====================================
2015-03-11 01:45:38 -05:00
Bugs fixed
----------
2015-03-13 20:59:56 -05:00
* #1769: allows generating quickstart files/dirs for destination dir that
2015-03-13 21:02:31 -05:00
doesn't overwrite existent files/dirs. Thanks to WAKAYAMA shirou.
2015-03-14 00:10:28 -05:00
* #1773: sphinx-quickstart doesn't accept non-ASCII character as a option argument.
2015-03-14 02:59:22 -05:00
* #1766: the message "least Python 2.6 to run" is at best misleading.
2015-03-14 04:54:20 -05:00
* #1772: cross reference in docstrings like ``:param .write:`` breaks building.
2015-03-14 09:29:16 -05:00
* #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.
2015-03-15 10:20:33 -05:00
* #1776: ``source_suffix = ['.rst']`` cause unfriendly error on prior version.
2015-03-16 08:03:21 -05:00
* #1771: automated .mo building doesn't work properly.
2015-03-16 17:31:58 -05:00
* #1783: Autodoc: Python2 Allow unicode string in __all__.
Thanks to Jens Hedegaard Nielsen.
2015-03-16 17:34:26 -05:00
* #1781: Setting `html_domain_indices` to a list raises a type check warnings.
2015-03-11 01:45:38 -05:00
2015-05-17 01:56:10 -05:00
2015-03-09 10:24:24 -05:00
Release 1.3 (released Mar 10, 2015)
===================================
2015-02-25 08:51:47 -06:00
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.
2015-03-07 16:57:05 -06:00
* Role ``numref`` uses ``%s`` as special character to indicate position of
figure numbers instead ``#`` symbol.
2015-02-25 08:51:47 -06:00
2015-02-26 14:44:46 -06:00
Features added
--------------
* Add convenience directives and roles to the C++ domain:
2015-02-28 16:25:45 -06:00
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
2015-02-27 06:09:15 -06:00
* The :confval:`source_suffix` config value can now be a list of multiple
suffixes.
2015-03-08 07:11:28 -05:00
* Add the ability to specify source parsers by source suffix with the
:confval:`source_parsers` config value.
2015-03-08 09:35:04 -05:00
* #1675: A new builder, AppleHelpBuilder, has been added that builds Apple
Help Books.
2015-02-26 14:44:46 -06:00
2015-02-27 09:20:40 -06:00
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".
2015-02-28 16:08:53 -06:00
* #1745: latex builder cause maximum recursion depth exceeded when a
footnote has a footnote mark itself.
2015-03-02 07:43:14 -06:00
* #1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6.
2015-03-02 17:13:14 -06:00
* #1658, #1750: No link created (and warning given) if option does not
begin with -, / or +. Thanks to Takayuki Hirai.
2015-03-05 16:47:06 -06:00
* #1753: C++, added missing support for more complex declarations.
2015-03-08 09:24:57 -05:00
* #1700: Add ``:caption:`` option for :rst:dir:`toctree`.
2015-03-08 09:38:28 -05:00
* #1742: ``:name:`` option is provided for :rst:dir:`toctree`, :rst:dir:`code-block` and
:rst:dir:`literalinclude` dirctives.
2015-03-09 07:37:39 -05:00
* #1756: Incorrect section titles in search that was introduced from 1.3b3.
2015-03-10 15:04:09 -05:00
* #1746: C++, fixed name lookup procedure, and added missing lookups in declarations.
2015-03-10 16:19:25 -05:00
* #1765: C++, fix old id generation to use fully qualified names.
2015-02-27 09:20:40 -06:00
2015-03-09 08:51:20 -05:00
Documentation
-------------
* #1651: Add ``vartype`` field descritpion for python domain.
2015-02-25 08:51:47 -06:00
2015-05-17 01:56:10 -05:00
2015-02-24 07:45:17 -06:00
Release 1.3b3 (released Feb 24, 2015)
=====================================
2014-12-05 05:03:07 -06:00
Incompatible changes
--------------------
2015-01-01 12:02:19 -06:00
* Dependency requirement updates: docutils 0.11, Pygments 2.0
2015-02-21 08:48:18 -06:00
* The ``gettext_enables`` config value has been renamed to
`gettext_additional_targets`.
2016-02-13 09:00:42 -06:00
* #1735: Use https://docs.python.org/ instead of ``http`` protocol.
2015-02-22 22:20:35 -06:00
It was used for `sphinx.ext.intersphinx` and some documentation.
2015-01-01 12:02:19 -06:00
2014-12-05 05:03:07 -06:00
Features added
--------------
2015-02-23 07:51:30 -06:00
* #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.
2015-01-05 11:49:06 -06:00
* Added ``highlight_options`` configuration value.
2015-01-10 12:40:59 -06:00
* The ``language`` config value is now available in the HTML templates.
2015-01-25 09:13:04 -06:00
* The ``env-updated`` event can now return a value, which is interpreted
as an iterable of additional docnames that need to be rewritten.
2015-02-08 14:40:23 -06:00
* #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.
2015-02-07 02:05:15 -06:00
* Add ``todo_include_todos`` config option to quickstart conf file, handled as
described in documentation.
2015-02-14 02:09:39 -06:00
* HTML breadcrumb items tag has class "nav-item" and "nav-item-N" (like
nav-item-0, 1, 2...).
2015-02-20 20:48:07 -06:00
* New option `sphinx-quickstart --use-make-mode` for generating Makefile that
use sphinx-build make-mode.
2015-02-22 00:36:43 -06:00
* #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'
2015-02-22 04:24:14 -06:00
- 'image'
2015-01-05 11:49:06 -06:00
2015-02-22 07:04:20 -06:00
* #1227: Add `html_scaled_image_link` config option to conf.py, to control
scaled image link.
2014-12-05 05:03:07 -06:00
Bugs fixed
----------
2015-01-05 11:28:44 -06:00
* LaTeX writer now generates correct markup for cells spanning multiple rows.
2015-01-15 01:26:40 -06:00
* #1674: Do not crash if a module's ``__all__`` is not a list of strings.
2015-01-18 01:08:46 -06:00
* #1629: Use VerbatimBorderColor to add frame to code-block in LaTeX
2015-01-16 23:37:09 -06:00
* On windows, make-mode didn't work on Win32 platform if sphinx was invoked as
``python sphinx-build.py``.
2015-01-19 12:50:05 -06:00
* #1687: linkcheck now treats 401 Unauthorized responses as "working".
2015-01-25 04:07:55 -06:00
* #1690: toctrees with ``glob`` option now can also contain entries for single
documents with explicit title.
2015-02-07 05:27:29 -06:00
* #1591: html search results for C++ elements now has correct interpage links.
2015-02-14 02:09:39 -06:00
* 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).
2015-02-15 01:48:49 -06:00
* #1722: restore ``toctree()`` template function behavior that was changed at 1.3b1.
2015-02-20 21:23:26 -06:00
* #1732: i18n: localized table caption raises exception.
2015-02-21 20:28:21 -06:00
* #1718: ``:numref:`` does not work with capital letters in the label
2015-02-22 09:38:09 -06:00
* #1630: resolve CSS conflicts, ``div.container`` css target for literal block wrapper
now renamed to ``div.literal-block-wrapper``.
2015-02-24 00:48:31 -06:00
* ``sphinx.util.pycompat`` has been restored in its backwards-compatibility;
slated for removal in Sphinx 1.4.
2015-02-22 09:29:05 -06:00
* #1719: LaTeX writer does not respect ``numref_format`` option in captions
2015-01-05 11:28:44 -06:00
2014-12-05 05:03:07 -06:00
2014-12-05 04:46:18 -06:00
Release 1.3b2 (released Dec 5, 2014)
====================================
2014-10-09 10:37:33 -05:00
Incompatible changes
--------------------
2014-12-03 08:17:48 -06:00
* update bundled ez_setup.py for setuptools-7.0 that requires Python 2.6 or
later.
2014-10-09 10:37:33 -05:00
Features added
--------------
2014-10-23 00:58:23 -05:00
* #1597: Added possibility to return a new template name from
`html-page-context`.
2014-10-31 05:14:14 -05:00
* PR#314, #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.
2014-10-23 00:58:23 -05:00
2014-10-09 10:37:33 -05:00
Bugs fixed
----------
2014-10-18 22:57:12 -05:00
* PR#311: sphinx-quickstart does not work on python 3.4.
2014-11-07 08:01:10 -06:00
* Fix :confval:`autodoc_docstring_signature` not working with signatures
in class docstrings.
2014-11-24 19:20:10 -06:00
* Rebuilding cause crash unexpectedly when source files were added.
2014-11-27 01:32:35 -06:00
* #1607: Fix a crash when building latexpdf with "howto" class
2014-12-05 01:42:30 -06:00
* #1251: Fix again. Sections which depth are lower than :tocdepth: should not
be shown on localtoc sidebar.
2014-12-18 10:14:57 -06:00
* make-mode didn't work on Win32 platform if sphinx was installed by wheel
package.
2014-10-18 22:57:12 -05:00
2014-10-09 10:37:33 -05:00
2014-10-09 10:05:46 -05:00
Release 1.3b1 (released Oct 10, 2014)
=====================================
2013-12-10 03:29:41 -06:00
2014-01-17 00:24:23 -06:00
Incompatible changes
--------------------
2014-08-30 10:33:35 -05:00
* 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.
2014-01-19 10:46:06 -06:00
* The deprecated config values ``exclude_trees``, ``exclude_dirnames`` and
2014-08-30 10:33:35 -05:00
``unused_docs`` have been removed.
2014-01-19 00:32:10 -06:00
* 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
2014-08-30 10:33:35 -05:00
will have to be adapted to handle this node.
2014-09-19 05:36:21 -05:00
* PR#269, #1476: replace ``<tt>`` tag by ``<code>``. User customized stylesheets
should be updated If the css contain some styles for ``tt>`` tag.
2014-08-30 10:33:35 -05:00
Thanks to Takeshi Komiya.
2014-09-19 06:18:29 -05:00
* #1543: `templates_path` is automatically added to
`exclude_patterns` to avoid reading autosummary rst templates in the
2014-08-30 10:33:35 -05:00
templates directory.
2014-09-19 06:18:29 -05:00
* Custom domains should implement the new `Domain.resolve_any_xref`
method to make the `any` role work properly.
2014-10-05 07:50:44 -05:00
* gettext builder: gettext doesn't emit uuid information to generated pot files
by default. Please set ``True`` to `gettext_uuid` to emit uuid information.
2014-10-05 08:25:50 -05:00
Additionally, if the ``python-levenshtein`` 3rd-party package is installed,
it will improve the calculation time.
2014-09-28 07:19:54 -05:00
* gettext builder: disable extracting/apply 'index' node by default. Please set
2015-02-21 08:48:18 -06:00
'index' to ``gettext_enables`` to enable extracting index entries.
2014-10-09 07:53:09 -05:00
* PR#307: Add frame to code-block in LaTeX. Thanks to Takeshi Komiya.
2014-01-19 00:32:10 -06:00
2014-07-26 00:19:40 -05:00
Features added
--------------
2014-01-10 07:58:36 -06:00
2014-08-30 10:33:35 -05:00
* Add support for Python 3.4.
* Add support for docutils 0.12
2014-01-20 01:54:04 -06:00
* Added ``sphinx.ext.napoleon`` extension for NumPy and Google style docstring
2014-08-30 10:33:35 -05:00
support.
2014-09-22 14:55:11 -05:00
* 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`.
2014-09-19 06:18:29 -05:00
* Added the `any` role that can be used to find a cross-reference of
2014-09-19 05:59:18 -05:00
*any* type in *any* domain. Custom domains should implement the new
2014-09-19 06:18:29 -05:00
`Domain.resolve_any_xref` method to make this work properly.
2014-09-17 05:22:14 -05:00
* Exception logs now contain the last 10 messages emitted by Sphinx.
2014-09-03 09:27:15 -05:00
* Added support for extension versions (a string returned by ``setup()``, these
2014-09-04 01:57:36 -05:00
can be shown in the traceback log files). Version requirements for extensions
2014-09-19 06:18:29 -05:00
can be specified in projects using the new `needs_extensions` config
2014-09-04 01:57:36 -05:00
value.
2014-09-19 06:18:29 -05:00
* Changing the default role within a document with the :dudir:`default-role`
2014-09-19 05:21:38 -05:00
directive is now supported.
2014-03-04 12:10:19 -06:00
* PR#214: Added stemming support for 14 languages, so that the built-in document
2014-08-30 10:33:35 -05:00
search can now handle these. Thanks to Shibukawa Yoshiki.
2014-10-09 07:53:09 -05:00
* PR#296, PR#303, #76: numfig feature: Assign numbers to figures, tables and
code-blocks. This feature is configured with `numfig`, `numfig_secnum_depth`
2014-10-09 10:19:17 -05:00
and `numfig_format`. Also `numref` role is available. Thanks to Takeshi
2014-10-09 07:53:09 -05:00
Komiya.
2014-01-10 07:58:36 -06:00
* PR#202: Allow "." and "~" prefixed references in ``:param:`` doc fields
2014-08-30 10:33:35 -05:00
for Python.
2014-09-19 06:18:29 -05:00
* PR#184: Add `autodoc_mock_imports`, allowing to mock imports of
2014-08-30 10:33:35 -05:00
external modules that need not be present when autodocumenting.
2014-01-10 14:44:14 -06:00
* #925: Allow list-typed config values to be provided on the command line,
2014-08-30 10:33:35 -05:00
like ``-D key=val1,val2``.
2014-09-19 06:18:29 -05:00
* #668: Allow line numbering of `code-block` and `literalinclude` directives
2014-01-11 02:07:29 -06:00
to start at an arbitrary line number, with a new ``lineno-start`` option.
2014-09-19 06:18:29 -05:00
* PR#172, PR#266: The `code-block` and `literalinclude`
2014-08-23 21:07:36 -05:00
directives now can have a ``caption`` option that shows a filename before the
2014-08-30 10:33:35 -05:00
code in the output. Thanks to Nasimul Haque, Takeshi Komiya.
* Prompt for the document language in sphinx-quickstart.
2014-03-01 01:28:27 -06:00
* PR#217: Added config values to suppress UUID and location information in
2014-08-30 10:33:35 -05:00
generated gettext catalogs.
2014-05-04 22:22:58 -05:00
* PR#236, #1456: apidoc: Add a -M option to put module documentation before
2014-08-30 10:33:35 -05:00
submodule documentation. Thanks to Wes Turner and Luc Saffre.
2014-06-07 04:32:56 -05:00
* #1434: Provide non-minified JS files for jquery.js and underscore.js to
2014-08-30 10:33:35 -05:00
clarify the source of the minified files.
* PR#252, #1291: Windows color console support. Thanks to meu31.
2014-08-03 02:42:28 -05:00
* PR#255: When generating latex references, also insert latex target/anchor
2014-08-30 10:33:35 -05:00
for the ids defined on the node. Thanks to Olivier Heurtier.
* PR#229: Allow registration of other translators. Thanks to Russell Sim.
2014-08-04 10:18:54 -05:00
* Add app.set_translator() API to register or override a Docutils translator
2014-09-19 06:18:29 -05:00
class like `html_translator_class`.
2014-08-30 10:33:35 -05:00
* PR#267, #1134: add 'diff' parameter to literalinclude. Thanks to Richard Wall
and WAKAYAMA shirou.
* PR#272: Added 'bizstyle' theme. Thanks to Shoji KUMAGAI.
2014-08-03 02:22:08 -05:00
* Automatically compile ``*.mo`` files from ``*.po`` files when
2014-09-19 06:18:29 -05:00
`gettext_auto_build` is True (default) and ``*.po`` is newer than
2014-08-30 10:33:35 -05:00
``*.mo`` file.
2014-09-19 06:18:29 -05:00
* #623: `sphinx.ext.viewcode` supports imported function/class aliases.
* PR#275: `sphinx.ext.intersphinx` supports multiple target for the
2014-08-30 10:33:35 -05:00
inventory. Thanks to Brigitta Sipocz.
2014-09-22 02:13:44 -05:00
* PR#261: Added the `env-before-read-docs` event that can be connected to modify
the order of documents before they are read by the environment.
2014-09-20 12:58:11 -05:00
* #1284: Program options documented with :rst:dir:`option` can now start with
``+``.
2014-09-22 22:26:32 -05:00
* PR#291: The caption of :rst:dir:`code-block` is recognised as a title of ref
target. Thanks to Takeshi Komiya.
2014-09-27 23:05:28 -05:00
* PR#298: Add new API: :meth:`~sphinx.application.Sphinx.add_latex_package`.
Thanks to Takeshi Komiya.
2015-02-21 08:48:18 -06:00
* #1344: add ``gettext_enables`` to enable extracting 'index' to gettext
2014-09-28 07:19:54 -05:00
catalog output / applying translation catalog to generated documentation.
2014-10-07 09:00:32 -05:00
* PR#301, #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.
2014-10-04 00:14:31 -05:00
* PR#299: add various options to sphinx-quickstart. Quiet mode option
``--quiet`` will skips wizard mode. Thanks to WAKAYAMA shirou.
2014-11-12 04:32:21 -06:00
* #1623: Return types specified with ``:rtype:`` are now turned into links if
possible.
2014-01-11 08:05:45 -06:00
2013-12-26 23:23:47 -06:00
Bugs fixed
----------
2014-10-07 18:59:01 -05:00
* #1438: Updated jQuery version from 1.8.3 to 1.11.1.
2014-09-20 12:58:11 -05:00
* #1568: Fix a crash when a "centered" directive contains a reference.
2014-11-07 08:03:06 -06:00
* Now sphinx.ext.autodoc works with python-2.5 again.
2014-09-09 03:27:00 -05:00
* #1563: :meth:`~sphinx.application.Sphinx.add_search_language` raises
AssertionError for correct type of argument. Thanks to rikoman.
2014-01-12 10:01:22 -06:00
* #1174: Fix smart quotes being applied inside roles like :rst:role:`program` or
2014-09-19 06:18:29 -05:00
`makevar`.
2014-05-05 02:21:32 -05:00
* PR#235: comment db schema of websupport lacked a length of the node_id field.
2014-08-30 10:33:35 -05:00
Thanks to solos.
2014-05-27 10:14:50 -05:00
* #1466,PR#241: Fix failure of the cpp domain parser to parse C+11
2014-08-30 10:33:35 -05:00
"variadic templates" declarations. Thanks to Victor Zverovich.
2014-09-19 05:36:21 -05:00
* #1459,PR#244: Fix default mathjax js path point to ``http://`` that cause
2014-08-30 10:33:35 -05:00
mixed-content error on HTTPS server. Thanks to sbrandtb and robo9k.
2014-06-14 03:03:57 -05:00
* PR#157: autodoc remove spurious signatures from @property decorated
2014-08-30 10:33:35 -05:00
attributes. Thanks to David Ham.
2014-07-04 19:30:11 -05:00
* PR#159: Add coverage targets to quickstart generated Makefile and make.bat.
2014-08-30 10:33:35 -05:00
Thanks to Matthias Troffaes.
2014-08-02 04:10:41 -05:00
* #1251: When specifying toctree :numbered: option and :tocdepth: metadata,
2014-09-19 05:36:21 -05:00
sub section number that is larger depth than ``:tocdepth:`` is shrunk.
2014-08-30 10:33:35 -05:00
* PR#260: Encode underscore in citation labels for latex export. Thanks to
Lennart Fricke.
2014-08-10 02:28:31 -05:00
* PR#264: Fix could not resolve xref for figure node with :name: option.
2014-08-30 10:33:35 -05:00
Thanks to Takeshi Komiya.
* PR#265: Fix could not capture caption of graphviz node by xref. Thanks to
Takeshi Komiya.
2015-02-08 14:40:23 -06:00
* PR#263, #1013, #1103: Rewrite of C++ domain. Thanks to Jakob Lykke Andersen.
2014-08-10 08:05:05 -05:00
* 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.
2014-09-19 06:18:29 -05:00
* PR#258, #939: Add dedent option for `code-block` and
`literalinclude`. Thanks to Zafar Siddiqui.
2014-08-18 09:16:26 -05:00
* PR#268: Fix numbering section does not work at singlehtml mode. It still
ad-hoc fix because there is a issue that section IDs are conflicted.
2014-08-30 10:33:35 -05:00
Thanks to Takeshi Komiya.
* PR#273, #1536: Fix RuntimeError with numbered circular toctree. Thanks to
Takeshi Komiya.
2014-08-19 16:16:02 -05:00
* PR#274: Set its URL as a default title value if URL appears in toctree.
2014-08-30 10:33:35 -05:00
Thanks to Takeshi Komiya.
2014-09-19 06:18:29 -05:00
* PR#276, #1381: `rfc` and `pep` roles support custom link
2014-08-30 10:33:35 -05:00
text. Thanks to Takeshi Komiya.
2014-08-21 00:17:04 -05:00
* PR#277, #1513: highlights for function pointers in argument list of
2014-09-19 06:18:29 -05:00
`c:function`. Thanks to Takeshi Komiya.
2014-08-21 00:54:06 -05:00
* PR#278: Fix section entries were shown twice if toctree has been put under
2014-08-30 10:33:35 -05:00
only directive. Thanks to Takeshi Komiya.
2014-09-19 05:36:21 -05:00
* #1547: pgen2 tokenizer doesn't recognize ``...`` literal (Ellipsis for py3).
2014-09-23 11:13:59 -05:00
* PR#294: On LaTeX builder, wrap float environment on writing literal_block
to avoid separation of caption and body. Thanks to Takeshi Komiya.
2014-09-25 12:29:02 -05:00
* PR#295, #1520: ``make.bat latexpdf`` mechanism to ``cd`` back to the current
directory. Thanks to Peter Suter.
2014-09-28 10:37:52 -05:00
* PR#297, #1571: Add imgpath property to all builders. It make easier to
develop builder extensions. Thanks to Takeshi Komiya.
2014-10-01 12:58:36 -05:00
* #1584: Point to master doc in HTML "top" link.
2014-10-04 09:21:03 -05:00
* #1585: Autosummary of modules broken in Sphinx-1.2.3.
2014-10-28 11:08:47 -05:00
* #1610: Sphinx cause AttributeError when MeCab search option is enabled and
python-mecab is not installed.
2015-01-15 01:26:40 -06:00
* #1674: Do not crash if a module's ``__all__`` is not a list of strings.
2015-01-15 01:41:18 -06:00
* #1673: Fix crashes with :confval:`nitpick_ignore` and ``:doc:`` references.
2015-01-17 01:01:53 -06:00
* #1686: ifconfig directive doesn't care about default config values.
2015-01-25 09:07:18 -06:00
* #1642: Fix only one search result appearing in Chrome.
2014-01-19 10:33:55 -06:00
2013-12-17 08:54:30 -06:00
Documentation
-------------
2014-05-11 21:04:16 -05:00
* Add clarification about the syntax of tags. (:file:`doc/markup/misc.rst`)
2013-12-17 08:54:30 -06:00
2013-12-10 03:29:41 -06:00
2014-09-01 09:20:28 -05:00
Release 1.2.3 (released Sep 1, 2014)
====================================
2014-03-02 01:47:18 -06:00
2014-07-25 16:33:57 -05:00
Features added
--------------
2014-09-19 05:36:21 -05:00
* #1518: ``sphinx-apidoc`` command now has a ``--version`` option to show version
2014-07-25 16:33:57 -05:00
information and exit
2014-08-11 10:09:50 -05:00
* New locales: Hebrew, European Portuguese, Vietnamese.
2014-07-25 16:33:57 -05:00
2014-03-02 01:47:18 -06:00
Bugs fixed
----------
2014-03-25 04:26:20 -05:00
* #636: Keep straight single quotes in literal blocks in the LaTeX build.
2014-03-20 20:58:41 -05:00
* #1419: Generated i18n sphinx.js files are missing message catalog entries
from '.js_t' and '.html'. The issue was introduced from Sphinx-1.1
2014-03-23 09:01:15 -05:00
* #1363: Fix i18n: missing python domain's cross-references with currentmodule
directive or currentclass directive.
2014-04-11 09:38:37 -05:00
* #1444: autosummary does not create the description from attributes docstring.
2014-05-03 10:43:50 -05:00
* #1457: In python3 environment, make linkcheck cause "Can't convert 'bytes'
object to str implicitly" error when link target url has a hash part.
Thanks to Jorge_C.
2014-06-08 11:43:34 -05:00
* #1467: Exception on Python3 if nonexistent method is specified by automethod
2014-06-21 03:05:31 -05:00
* #1441: autosummary can't handle nested classes correctly.
2014-09-19 05:36:21 -05:00
* #1499: With non-callable ``setup`` in a conf.py, now sphinx-build emits
a user-friendly error message.
2014-07-01 10:09:11 -05:00
* #1502: In autodoc, fix display of parameter defaults containing backslashes.
2014-07-04 10:11:59 -05:00
* #1226: autodoc, autosummary: importing setup.py by automodule will invoke
2014-09-19 05:36:21 -05:00
setup process and execute ``sys.exit()``. Now sphinx avoids SystemExit
2014-07-04 10:11:59 -05:00
exception and emits warnings without unexpected termination.
2014-07-12 06:50:15 -05:00
* #1503: py:function directive generate incorrectly signature when specifying
2014-09-19 05:36:21 -05:00
a default parameter with an empty list ``[]``. Thanks to Geert Jansen.
2014-07-12 20:44:48 -05:00
* #1508: Non-ASCII filename raise exception on make singlehtml, latex, man,
texinfo and changes.
2014-08-11 10:11:23 -05:00
* #1531: On Python3 environment, docutils.conf with 'source_link=true' in the
general section cause type error.
2014-08-14 10:31:21 -05:00
* PR#270, #1533: Non-ASCII docstring cause UnicodeDecodeError when uses with
inheritance-diagram directive. Thanks to WAKAYAMA shirou.
2014-08-24 07:08:30 -05:00
* PR#281, PR#282, #1509: TODO extension not compatible with websupport. Thanks
to Takeshi Komiya.
2014-08-25 11:39:26 -05:00
* #1477: gettext does not extract nodes.line in a table or list.
2014-09-19 05:36:21 -05:00
* #1544: ``make text`` generates wrong table when it has empty table cells.
2014-08-26 08:37:18 -05:00
* #1522: Footnotes from table get displayed twice in LaTeX. This problem has
been appeared from Sphinx-1.2.1 by #949.
2014-08-28 11:14:54 -05:00
* #508: Sphinx every time exit with zero when is invoked from setup.py command.
2014-09-19 05:36:21 -05:00
ex. ``python setup.py build_sphinx -b doctest`` return zero even if doctest
2014-08-28 11:14:54 -05:00
failed.
2014-03-02 01:47:18 -06:00
2014-03-02 01:41:38 -06:00
Release 1.2.2 (released Mar 2, 2014)
====================================
2014-01-19 12:18:15 -06:00
2014-01-20 14:18:13 -06:00
Bugs fixed
----------
2014-09-19 06:18:29 -05:00
* PR#211: When checking for existence of the `html_logo` file, check
2014-01-20 14:18:13 -06:00
the full relative path and not the basename.
2014-01-20 14:20:19 -06:00
* PR#212: Fix traceback with autodoc and ``__init__`` methods without docstring.
2014-01-21 11:41:19 -06:00
* PR#213: Fix a missing import in the setup command.
2014-01-22 10:42:38 -06:00
* #1357: Option names documented by :rst:dir:`option` are now again allowed to
not start with a dash or slash, and referencing them will work correctly.
2014-01-23 03:24:58 -06:00
* #1358: Fix handling of image paths outside of the source directory when using
the "wildcard" style reference.
2014-02-03 21:35:04 -06:00
* #1374: Fix for autosummary generating overly-long summaries if first line
doesn't end with a period.
2014-03-01 02:13:32 -06:00
* #1383: Fix Python 2.5 compatibility of sphinx-apidoc.
2014-03-01 02:23:09 -06:00
* #1391: Actually prevent using "pngmath" and "mathjax" extensions at the same
time in sphinx-quickstart.
2014-03-01 02:25:36 -06:00
* #1386: Fix bug preventing more than one theme being added by the entry point
mechanism.
2014-03-01 02:27:13 -06:00
* #1370: Ignore "toctree" nodes in text writer, instead of raising.
2014-03-01 23:40:29 -06:00
* #1364: Fix 'make gettext' fails when the '.. todolist::' directive is present.
2014-03-02 01:02:46 -06:00
* #1367: Fix a change of PR#96 that break sphinx.util.docfields.Field.make_field
2014-09-19 05:36:21 -05:00
interface/behavior for ``item`` argument usage.
2014-01-20 14:20:19 -06:00
2014-01-21 12:09:38 -06:00
Documentation
-------------
* Extended the :ref:`documentation about building extensions <dev-extensions>`.
2014-01-19 12:18:15 -06:00
2014-01-19 11:47:49 -06:00
Release 1.2.1 (released Jan 19, 2014)
=====================================
2013-12-10 03:29:41 -06:00
2013-12-26 23:23:47 -06:00
Bugs fixed
----------
2013-12-27 02:32:20 -06:00
* #1335: Fix autosummary template overloading with exclamation prefix like
2013-12-26 23:23:47 -06:00
``{% extends "!autosummary/class.rst" %}`` cause infinite recursive function
2014-01-19 11:47:49 -06:00
call. This was caused by PR#181.
2014-01-01 21:42:12 -06:00
* #1337: Fix autodoc with ``autoclass_content="both"`` uses useless
``object.__init__`` docstring when class does not have ``__init__``.
2014-01-12 05:47:37 -06:00
This was caused by a change for #1138.
2014-01-06 17:50:37 -06:00
* #1340: Can't search alphabetical words on the HTML quick search generated
with language='ja'.
2014-09-19 06:18:29 -05:00
* #1319: Do not crash if the `html_logo` file does not exist.
2014-01-10 13:31:41 -06:00
* #603: Do not use the HTML-ized title for building the search index (that
resulted in "literal" being found on every page with a literal in the
title).
2014-01-10 13:48:20 -06:00
* #751: Allow production lists longer than a page in LaTeX by using longtable.
2014-01-10 14:01:24 -06:00
* #764: Always look for stopwords lowercased in JS search.
* #814: autodoc: Guard against strange type objects that don't have
``__bases__``.
2014-01-10 14:51:51 -06:00
* #932: autodoc: Do not crash if ``__doc__`` is not a string.
2014-01-12 05:47:37 -06:00
* #933: Do not crash if an :rst:role:`option` value is malformed (contains
spaces but no option name).
2014-01-11 02:07:11 -06:00
* #908: On Python 3, handle error messages from LaTeX correctly in the pngmath
extension.
2014-01-11 02:11:03 -06:00
* #943: In autosummary, recognize "first sentences" to pull from the docstring
if they contain uppercase letters.
2014-01-11 02:17:27 -06:00
* #923: Take the entire LaTeX document into account when caching
pngmath-generated images. This rebuilds them correctly when
2016-01-02 02:58:16 -06:00
``pngmath_latex_preamble`` changes.
2014-01-11 02:50:27 -06:00
* #901: Emit a warning when using docutils' new "math" markup without a Sphinx
math extension active.
2014-01-11 03:00:49 -06:00
* #845: In code blocks, when the selected lexer fails, display line numbers
nevertheless if configured.
2014-01-11 03:19:52 -06:00
* #929: Support parsed-literal blocks in LaTeX output correctly.
2014-01-11 13:13:14 -06:00
* #949: Update the tabulary.sty packed with Sphinx.
2014-01-11 13:54:42 -06:00
* #1050: Add anonymous labels into ``objects.inv`` to be referenced via
2014-01-12 05:47:37 -06:00
:mod:`~sphinx.ext.intersphinx`.
2014-01-11 14:00:31 -06:00
* #1095: Fix print-media stylesheet being included always in the "scrolls"
theme.
2014-01-11 14:08:52 -06:00
* #1085: Fix current classname not getting set if class description has
``:noindex:`` set.
2014-01-12 09:20:13 -06:00
* #1181: Report option errors in autodoc directives more gracefully.
2014-01-12 09:43:14 -06:00
* #1155: Fix autodocumenting C-defined methods as attributes in Python 3.
2014-01-12 10:19:58 -06:00
* #1233: Allow finding both Python classes and exceptions with the "class" and
"exc" roles in intersphinx.
2014-09-19 06:18:29 -05:00
* #1198: Allow "image" for the "figwidth" option of the :dudir:`figure`
2014-01-12 12:28:47 -06:00
directive as documented by docutils.
2014-01-12 12:44:04 -06:00
* #1152: Fix pycode parsing errors of Python 3 code by including two grammar
versions for Python 2 and 3, and loading the appropriate version for the
running Python version.
2014-01-12 12:58:31 -06:00
* #1017: Be helpful and tell the user when the argument to :rst:dir:`option`
does not match the required format.
2014-09-19 06:18:29 -05:00
* #1345: Fix two bugs with `nitpick_ignore`; now you don't have to
2014-01-12 13:45:34 -06:00
remove the store environment for changes to have effect.
2014-01-12 14:29:35 -06:00
* #1072: In the JS search, fix issues searching for upper-cased words by
lowercasing words before stemming.
2014-01-12 14:48:10 -06:00
* #1299: Make behavior of the :rst:dir:`math` directive more consistent and
avoid producing empty environments in LaTeX output.
2014-01-12 15:04:24 -06:00
* #1308: Strip HTML tags from the content of "raw" nodes before feeding it
to the search indexer.
2014-01-12 16:01:59 -06:00
* #1249: Fix duplicate LaTeX page numbering for manual documents.
2014-01-12 16:52:16 -06:00
* #1292: In the linkchecker, retry HEAD requests when denied by HTTP 405.
Also make the redirect code apparent and tweak the output a bit to be
more obvious.
2014-01-17 00:08:32 -06:00
* #1285: Avoid name clashes between C domain objects and section titles.
2014-01-19 02:54:24 -06:00
* #848: Always take the newest code in incremental rebuilds with the
:mod:`sphinx.ext.viewcode` extension.
2014-01-19 04:14:38 -06:00
* #979, #1266: Fix exclude handling in ``sphinx-apidoc``.
2014-01-19 04:36:11 -06:00
* #1302: Fix regression in :mod:`sphinx.ext.inheritance_diagram` when
documenting classes that can't be pickled.
2014-01-19 04:38:41 -06:00
* #1316: Remove hard-coded ``font-face`` resources from epub theme.
2014-01-19 04:42:44 -06:00
* #1329: Fix traceback with empty translation msgstr in .po files.
2014-01-19 08:39:31 -06:00
* #1300: Fix references not working in translated documents in some instances.
2014-01-19 10:33:55 -06:00
* #1283: Fix a bug in the detection of changed files that would try to access
doctrees of deleted documents.
2014-09-19 06:18:29 -05:00
* #1330: Fix `exclude_patterns` behavior with subdirectories in the
`html_static_path`.
2014-01-19 11:21:23 -06:00
* #1323: Fix emitting empty ``<ul>`` tags in the HTML writer, which is not
valid HTML.
2014-01-19 11:40:00 -06:00
* #1147: Don't emit a sidebar search box in the "singlehtml" builder.
2013-12-17 08:54:30 -06:00
Documentation
-------------
* #1325: Added a "Intersphinx" tutorial section. (:file:`doc/tutorial.rst`)
2013-12-10 03:29:41 -06:00
2013-12-10 03:24:44 -06:00
Release 1.2 (released Dec 10, 2013)
===================================
2013-10-12 12:27:49 -05:00
2013-10-12 13:48:44 -05:00
Features added
--------------
* Added ``sphinx.version_info`` tuple for programmatic checking of the Sphinx
version.
2013-10-12 12:27:49 -05:00
Incompatible changes
--------------------
* Removed the ``sphinx.ext.refcounting`` extension -- it is very specific to
CPython and has no place in the main distribution.
2013-10-12 15:38:54 -05:00
Bugs fixed
----------
* Restore ``versionmodified`` CSS class for versionadded/changed and deprecated
directives.
2013-12-26 23:23:47 -06:00
2014-09-19 05:36:21 -05:00
* PR#181: Fix ``html_theme_path = ['.']`` is a trigger of rebuild all documents
2013-12-26 23:23:47 -06:00
always (This change keeps the current "theme changes cause a rebuild"
feature).
2013-10-12 15:38:54 -05:00
2013-10-20 12:13:37 -05:00
* #1296: Fix invalid charset in HTML help generated HTML files for default
locale.
2013-11-12 09:17:09 -06:00
* PR#190: Fix gettext does not extract figure caption and rubric title inside
other blocks. Thanks to Michael Schlenker.
2013-11-16 02:54:25 -06:00
* PR#176: Make sure setup_command test can always import Sphinx. Thanks to
Dmitry Shachnev.
2013-11-16 21:39:27 -06:00
* #1311: Fix test_linkcode.test_html fails with C locale and Python 3.
2013-11-17 02:37:28 -06:00
* #1269: Fix ResourceWarnings with Python 3.2 or later.
2013-12-09 04:55:51 -06:00
* #1138: Fix: When ``autodoc_docstring_signature = True`` and
``autoclass_content = 'init'`` or ``'both'``, __init__ line should be
removed from class documentation.
2013-10-12 12:27:49 -05:00
2013-10-03 12:56:38 -05:00
Release 1.2 beta3 (released Oct 3, 2013)
========================================
2013-09-23 05:53:22 -05:00
Features added
--------------
2013-10-03 12:56:38 -05:00
* The Sphinx error log files will now include a list of the loaded extensions
for help in debugging.
2013-09-23 05:53:22 -05:00
Incompatible changes
--------------------
2013-09-23 08:58:37 -05:00
* PR#154: Remove "sphinx" prefix from LaTeX class name except 'sphinxmanual'
and 'sphinxhowto'. Now you can use your custom document class without
'sphinx' prefix. Thanks to Erik B.
2013-09-23 05:53:22 -05:00
Bugs fixed
----------
2013-09-29 02:19:11 -05:00
* #1265: Fix i18n: crash when translating a section name that is pointed to from
a named target.
* A wrong condition broke the search feature on first page that is usually
index.rst. This issue was introduced in 1.2b1.
2013-10-03 01:43:22 -05:00
* #703: When Sphinx can't decode filenames with non-ASCII characters, Sphinx now
2013-09-29 02:19:11 -05:00
catches UnicodeError and will continue if possible instead of raising the
exception.
2013-09-23 05:53:22 -05:00
2013-09-17 08:46:04 -05:00
Release 1.2 beta2 (released Sep 17, 2013)
=========================================
2013-04-13 08:44:37 -05:00
2013-04-14 10:56:13 -05:00
Features added
--------------
2013-09-17 08:28:02 -05:00
* ``apidoc`` now ignores "_private" modules by default, and has an option ``-P``
to include them.
* ``apidoc`` now has an option to not generate headings for packages and
modules, for the case that the module docstring already includes a reST
heading.
* PR#161: ``apidoc`` can now write each module to a standalone page instead of
combining all modules in a package on one page.
2013-04-14 10:56:13 -05:00
* Builders: rebuild i18n target document when catalog updated.
2013-09-16 01:47:41 -05:00
* Support docutils.conf 'writers' and 'html4css1 writer' section in the HTML
writer. The latex, manpage and texinfo writers also support their respective
'writers' sections.
2014-09-19 06:18:29 -05:00
* The new `html_extra_path` config value allows to specify directories
2013-09-16 01:47:41 -05:00
with files that should be copied directly to the HTML output directory.
2013-09-16 01:00:03 -05:00
* Autodoc directives for module data and attributes now support an
``annotation`` option, so that the default display of the data/attribute
value can be overridden.
2013-09-16 02:26:14 -05:00
* PR#136: Autodoc directives now support an ``imported-members`` option to
include members imported from different modules.
2013-09-16 02:02:06 -05:00
* New locales: Macedonian, Sinhala, Indonesian.
2013-09-16 09:57:58 -05:00
* Theme package collection by using setuptools plugin mechanism.
2013-04-14 10:56:13 -05:00
2013-06-03 22:30:10 -05:00
Incompatible changes
--------------------
2013-06-12 22:54:05 -05:00
* PR#144, #1182: Force timezone offset to LocalTimeZone on POT-Creation-Date
that was generated by gettext builder. Thanks to masklinn and Jakub Wilk.
2013-06-03 22:30:10 -05:00
2013-04-13 08:44:37 -05:00
Bugs fixed
----------
2013-09-16 01:00:03 -05:00
* PR#132: Updated jQuery version to 1.8.3.
2013-06-10 18:19:52 -05:00
* PR#141, #982: Avoid crash when writing PNG file using Python 3. Thanks to
2013-06-04 04:17:10 -05:00
Marcin Wojdyr.
2013-06-05 00:00:59 -05:00
* PR#145: In parallel builds, sphinx drops second document file to write.
Thanks to tychoish.
2013-09-16 01:00:03 -05:00
* PR#151: Some styling updates to tables in LaTeX.
* PR#153: The "extensions" config value can now be overridden.
* PR#155: Added support for some C++11 function qualifiers.
2013-09-16 01:47:41 -05:00
* Fix: 'make gettext' caused UnicodeDecodeError when templates contain utf-8
encoded strings.
2013-09-16 03:36:16 -05:00
* #828: use inspect.getfullargspec() to be able to document functions with
keyword-only arguments on Python 3.
2013-09-16 03:55:46 -05:00
* #1090: Fix i18n: multiple cross references (term, ref, doc) in the same line
return the same link.
2013-09-16 01:47:41 -05:00
* #1157: Combination of 'globaltoc.html' and hidden toctree caused exception.
2013-09-16 01:00:03 -05:00
* #1159: fix wrong generation of objects inventory for Python modules, and
add a workaround in intersphinx to fix handling of affected inventories.
2013-09-16 01:47:41 -05:00
* #1160: Citation target missing caused an AssertionError.
* #1162, PR#139: singlehtml builder didn't copy images to _images/.
* #1173: Adjust setup.py dependencies because Jinja2 2.7 discontinued
compatibility with Python < 3.3 and Python < 2.6. Thanks to Alexander Dupuy.
2013-09-16 03:45:43 -05:00
* #1185: Don't crash when a Python module has a wrong or no encoding declared,
and non-ASCII characters are included.
2013-06-08 19:06:21 -05:00
* #1188: sphinx-quickstart raises UnicodeEncodeError if "Project version"
includes non-ASCII characters.
2013-09-16 01:47:41 -05:00
* #1189: "Title underline is too short" WARNING is given when using fullwidth
2013-06-08 19:48:43 -05:00
characters to "Project name" on quickstart.
2013-09-16 01:47:41 -05:00
* #1190: Output TeX/texinfo/man filename has no basename (only extension)
2013-10-03 01:43:22 -05:00
when using non-ASCII characters in the "Project name" on quickstart.
2013-09-16 03:55:46 -05:00
* #1192: Fix escaping problem for hyperlinks in the manpage writer.
2013-06-20 22:28:32 -05:00
* #1193: Fix i18n: multiple link references in the same line return the same
link.
* #1176: Fix i18n: footnote reference number missing for auto numbered named
footnote and auto symbol footnote.
2013-09-16 01:47:41 -05:00
* PR#146,#1172: Fix ZeroDivisionError in parallel builds. Thanks to tychoish.
2013-09-16 03:34:29 -05:00
* #1204: Fix wrong generation of links to local intersphinx targets.
2013-07-03 03:19:10 -05:00
* #1206: Fix i18n: gettext did not translate admonition directive's title.
2013-09-16 01:47:41 -05:00
* #1232: Sphinx generated broken ePub files on Windows.
2013-09-16 02:31:05 -05:00
* #1259: Guard the debug output call when emitting events; to prevent the
repr() implementation of arbitrary objects causing build failures.
2013-09-17 06:32:18 -05:00
* #1142: Fix NFC/NFD normalizing problem of rst filename on Mac OS X.
2013-09-17 07:10:42 -05:00
* #1234: Ignoring the string consists only of white-space characters.
2013-04-13 08:44:37 -05:00
2013-09-16 01:47:41 -05:00
Release 1.2 beta1 (released Mar 31, 2013)
2013-03-31 08:45:44 -05:00
=========================================
2011-10-09 16:31:15 -05:00
2013-03-29 06:28:38 -05:00
Incompatible changes
--------------------
* Removed ``sphinx.util.compat.directive_dwim()`` and
``sphinx.roles.xfileref_role()`` which were deprecated since version 1.0.
2014-09-19 06:18:29 -05:00
* PR#122: the files given in `latex_additional_files` now override TeX
2013-03-29 06:51:52 -05:00
files included by Sphinx, such as ``sphinx.sty``.
2014-09-19 06:18:29 -05:00
* PR#124: the node generated by `versionadded`,
`versionchanged` and `deprecated` directives now includes
2013-03-29 06:55:58 -05:00
all added markup (such as "New in version X") as child nodes, and no
additional text must be generated by writers.
* PR#99: the :rst:dir:`seealso` directive now generates admonition nodes instead
of the custom ``seealso`` node.
2013-03-10 08:07:31 -05:00
2013-03-29 06:09:20 -05:00
Features added
--------------
2012-10-28 13:06:48 -05:00
2013-03-29 06:09:20 -05:00
* Markup
2012-12-02 08:37:25 -06:00
2013-03-29 06:09:20 -05:00
- The :rst:dir:`toctree` directive and the ``toctree()`` template function now
have an ``includehidden`` option that includes hidden toctree entries (bugs
#790 and #1047). A bug in the ``maxdepth`` option for the ``toctree()``
template function has been fixed (bug #1046).
- PR#99: Strip down seealso directives to normal admonitions. This removes
their unusual CSS classes (admonition-see-also), inconsistent LaTeX
admonition title ("See Also" instead of "See also"), and spurious indentation
in the text builder.
2012-12-02 08:37:25 -06:00
2013-03-29 06:09:20 -05:00
* HTML builder
2012-12-02 08:37:25 -06:00
2013-04-15 01:56:57 -05:00
- #783: Create a link to full size image if it is scaled with width or height.
2013-03-29 06:09:20 -05:00
- #1067: Improve the ordering of the JavaScript search results: matches in titles
come before matches in full text, and object results are better categorized.
Also implement a pluggable search scorer.
- #1053: The "rightsidebar" and "collapsiblesidebar" HTML theme options now work
together.
- Update to jQuery 1.7.1 and Underscore.js 1.3.1.
2012-12-04 21:10:15 -06:00
2013-02-20 04:09:50 -06:00
* Texinfo builder
- An "Index" node is no longer added when there are no entries.
- "deffn" categories are no longer capitalized if they contain capital
letters.
- ``desc_annotation`` nodes are now rendered.
- ``strong`` and ``emphasis`` nodes are now formatted like
``literal``\s. The reason for this is because the standard Texinfo markup
(``*strong*`` and ``_emphasis_``) resulted in confusing output due to the
common usage of using these constructs for documenting parameter names.
- Field lists formatting has been tweaked to better display
"Info field lists".
- ``system_message`` and ``problematic`` nodes are now formatted in a similar
fashion as done by the text builder.
- "en-dash" and "em-dash" conversion of hyphens is no longer performed in
option directive signatures.
- ``@ref`` is now used instead of ``@pxref`` for cross-references which
prevents the word "see" from being added before the link (does not affect
the Info output).
- The ``@finalout`` command has been added for better TeX output.
- ``transition`` nodes are now formatted using underscores ("_") instead of
asterisks ("*").
- The default value for the ``paragraphindent`` has been changed from 2 to 0
meaning that paragraphs are no longer indented by default.
2014-09-19 06:18:29 -05:00
- #1110: A new configuration value `texinfo_no_detailmenu` has been
2013-02-20 04:09:50 -06:00
added for controlling whether a ``@detailmenu`` is added in the "Top"
node's menu.
- Detailed menus are no longer created except for the "Top" node.
- Fixed an issue where duplicate domain indices would result in invalid
output.
2013-03-29 06:09:20 -05:00
* LaTeX builder:
2014-09-19 06:18:29 -05:00
- PR#115: Add ``'transition'`` item in `latex_elements` for
2013-03-29 06:09:20 -05:00
customizing how transitions are displayed. Thanks to Jeff Klukas.
- PR#114: The LaTeX writer now includes the "cmap" package by default. The
2014-09-19 06:18:29 -05:00
``'cmappkg'`` item in `latex_elements` can be used to control this.
2013-03-29 06:09:20 -05:00
Thanks to Dmitry Shachnev.
2014-09-19 06:18:29 -05:00
- The ``'fontpkg'`` item in `latex_elements` now defaults to ``''``
2015-02-14 03:13:37 -06:00
when the :confval:`language` uses the Cyrillic script. Suggested by Dmitry
2013-03-29 06:09:20 -05:00
Shachnev.
2014-09-19 06:18:29 -05:00
- The `latex_documents`, `texinfo_documents`, and
`man_pages` configuration values will be set to default values based
2013-03-29 06:09:20 -05:00
on the :confval:`master_doc` if not explicitly set in :file:`conf.py`.
2014-06-19 11:14:47 -05:00
Previously, if these values were not set, no output would be generated by
2013-03-29 06:09:20 -05:00
their respective builders.
* Internationalization:
- Add i18n capabilities for custom templates. For example: The Sphinx
reference documentation in doc directory provides a ``sphinx.pot`` file with
message strings from ``doc/_templates/*.html`` when using ``make gettext``.
2014-01-18 09:23:17 -06:00
- PR#61,#703: Add support for non-ASCII filename handling.
2014-01-18 07:57:02 -06:00
2013-03-29 06:09:20 -05:00
* Other builders:
- Added the Docutils-native XML and pseudo-XML builders. See
:class:`XMLBuilder` and :class:`PseudoXMLBuilder`.
- PR#45: The linkcheck builder now checks ``#anchor``\ s for existence.
2014-09-19 06:18:29 -05:00
- PR#123, #1106: Add `epub_use_index` configuration value. If
provided, it will be used instead of `html_use_index` for epub
2013-04-03 12:28:16 -05:00
builder.
2014-09-19 06:18:29 -05:00
- PR#126: Add `epub_tocscope` configuration value. The setting
2013-04-03 12:28:16 -05:00
controls the generation of the epub toc. The user can now also include
hidden toc entries.
2014-09-19 06:18:29 -05:00
- PR#112: Add `epub_show_urls` configuration value.
2013-03-29 06:09:20 -05:00
* Extensions:
- PR#52: ``special_members`` flag to autodoc now behaves like ``members``.
- PR#47: Added :mod:`sphinx.ext.linkcode` extension.
- PR#25: In inheritance diagrams, the first line of the class docstring
is now the tooltip for the class.
* Command-line interfaces:
- PR#75: Added ``--follow-links`` option to sphinx-apidoc.
2016-01-11 22:36:12 -06:00
- #869: sphinx-build now has the option ``-T`` for printing the full
2013-03-29 06:09:20 -05:00
traceback after an unhandled exception.
2016-01-11 22:36:12 -06:00
- sphinx-build now supports the standard ``--help`` and ``--version`` options.
2013-03-29 06:09:20 -05:00
- sphinx-build now provides more specific error messages when called with
invalid options or arguments.
2016-01-11 22:36:12 -06:00
- sphinx-build now has a verbose option ``-v`` which can be repeated for
2014-06-19 11:14:47 -05:00
greater effect. A single occurrence provides a slightly more verbose output
2013-03-29 06:09:20 -05:00
than normal. Two or more occurrences of this option provides more detailed
output which may be useful for debugging.
* Locales:
- PR#74: Fix some Russian translation.
- PR#54: Added Norwegian bokmaal translation.
- PR#35: Added Slovak translation.
- PR#28: Added Hungarian translation.
- #1113: Add Hebrew locale.
- #1097: Add Basque locale.
- #1037: Fix typos in Polish translation. Thanks to Jakub Wilk.
- #1012: Update Estonian translation.
* Optimizations:
- Speed up building the search index by caching the results of the word
stemming routines. Saves about 20 seconds when building the Python
documentation.
2013-03-29 07:01:21 -05:00
- PR#108: Add experimental support for parallel building with a new
2016-01-11 22:36:12 -06:00
:option:`sphinx-build -j` option.
2013-03-29 06:09:20 -05:00
Documentation
-------------
* PR#88: Added the "Sphinx Developer's Guide" (:file:`doc/devguide.rst`)
which outlines the basic development process of the Sphinx project.
* Added a detailed "Installing Sphinx" document (:file:`doc/install.rst`).
Bugs fixed
----------
* PR#124: Fix paragraphs in versionmodified are ignored when it has no
2013-03-29 06:55:58 -05:00
dangling paragraphs. Fix wrong html output (nested ``<p>`` tag). Fix
versionmodified is not translatable. Thanks to Nozomu Kaneko.
2013-03-29 06:09:20 -05:00
* PR#111: Respect add_autodoc_attrgetter() even when inherited-members is set.
Thanks to A. Jesse Jiryu Davis.
* PR#97: Fix footnote handling in translated documents.
* Fix text writer not handling visit_legend for figure directive contents.
* Fix text builder not respecting wide/fullwidth characters: title underline
width, table layout width and text wrap width.
2013-03-30 06:30:36 -05:00
* Fix leading space in LaTeX table header cells.
2013-03-30 06:23:04 -05:00
* #1132: Fix LaTeX table output for multi-row cells in the first column.
2013-03-30 11:53:04 -05:00
* #1128: Fix Unicode errors when trying to format time strings with a
non-standard locale.
2013-03-30 08:10:37 -05:00
* #1127: Fix traceback when autodoc tries to tokenize a non-Python file.
2013-03-30 06:00:51 -05:00
* #1126: Fix double-hyphen to en-dash conversion in wrong places such as
command-line option names in LaTeX.
2014-09-19 06:18:29 -05:00
* #1123: Allow whitespaces in filenames given to `literalinclude`.
2013-04-01 04:56:15 -05:00
* #1120: Added improvements about i18n for themes "basic", "haiku" and
"scrolls" that Sphinx built-in. Thanks to Leonardo J. Caballero G.
* #1118: Updated Spanish translation. Thanks to Leonardo J. Caballero G.
2013-03-30 05:44:43 -05:00
* #1117: Handle .pyx files in sphinx-apidoc.
2013-03-30 06:44:39 -05:00
* #1112: Avoid duplicate download files when referenced from documents in
different ways (absolute/relative).
2013-03-29 06:09:20 -05:00
* #1111: Fix failure to find uppercase words in search when
2014-09-19 06:18:29 -05:00
`html_search_language` is 'ja'. Thanks to Tomo Saito.
2013-03-29 06:09:20 -05:00
* #1108: The text writer now correctly numbers enumerated lists with
non-default start values (based on patch by Ewan Edwards).
2013-03-30 11:45:42 -05:00
* #1102: Support multi-context "with" statements in autodoc.
2013-03-29 06:09:20 -05:00
* #1090: Fix gettext not extracting glossary terms.
* #1074: Add environment version info to the generated search index to avoid
compatibility issues with old builds.
* #1070: Avoid un-pickling issues when running Python 3 and the saved
environment was created under Python 2.
* #1069: Fixed error caused when autodoc would try to format signatures of
"partial" functions without keyword arguments (patch by Artur Gaspar).
* #1062: sphinx.ext.autodoc use __init__ method signature for class signature.
* #1055: Fix web support with relative path to source directory.
* #1043: Fix sphinx-quickstart asking again for yes/no questions because
``input()`` returns values with an extra '\r' on Python 3.2.0 +
Windows. Thanks to Régis Décamps.
* #1041: Fix failure of the cpp domain parser to parse a const type with a
modifier.
* #1038: Fix failure of the cpp domain parser to parse C+11 "static constexpr"
declarations. Thanks to Jakub Wilk.
* #1029: Fix intersphinx_mapping values not being stable if the mapping has
plural key/value set with Python 3.3.
* #1028: Fix line block output in the text builder.
* #1024: Improve Makefile/make.bat error message if Sphinx is not found. Thanks
to Anatoly Techtonik.
* #1018: Fix "container" directive handling in the text builder.
* #1015: Stop overriding jQuery contains() in the JavaScript.
* #1010: Make pngmath images transparent by default; IE7+ should handle it.
* #1008: Fix test failures with Python 3.3.
2013-03-30 08:00:43 -05:00
* #995: Fix table-of-contents and page numbering for the LaTeX "howto" class.
2013-03-29 06:09:20 -05:00
* #976: Fix gettext does not extract index entries.
* PR#72: #975: Fix gettext not extracting definition terms before docutils 0.10.
2013-03-30 06:49:59 -05:00
* #961: Fix LaTeX output for triple quotes in code snippets.
2013-03-29 06:09:20 -05:00
* #958: Do not preserve ``environment.pickle`` after a failed build.
* #955: Fix i18n transformation.
* #940: Fix gettext does not extract figure caption.
* #920: Fix PIL packaging issue that allowed to import ``Image`` without PIL
namespace. Thanks to Marc Schlaich.
2013-03-30 05:30:48 -05:00
* #723: Fix the search function on local files in WebKit based browsers.
2013-03-29 06:09:20 -05:00
* #440: Fix coarse timestamp resolution in some filesystem generating a wrong
list of outdated files.
2012-03-10 15:24:59 -06:00
2012-03-10 14:42:25 -06:00
Release 1.1.3 (Mar 10, 2012)
============================
2012-01-29 03:00:28 -06:00
* PR#40: Fix ``safe_repr`` function to decode bytestrings with non-ASCII
characters correctly.
2012-01-29 03:08:27 -06:00
* PR#37: Allow configuring sphinx-apidoc via ``SPHINX_APIDOC_OPTIONS``.
2012-01-29 03:09:34 -06:00
* PR#34: Restore Python 2.4 compatibility.
2012-01-29 03:12:07 -06:00
* PR#36: Make the "bibliography to TOC" fix in LaTeX output specific to
the document class.
2012-01-29 03:21:01 -06:00
* #695: When the highlight language "python" is specified explicitly,
do not try to parse the code to recognize non-Python snippets.
2012-01-29 03:25:34 -06:00
* #859: Fix exception under certain circumstances when not finding
appropriate objects to link to.
2012-01-29 03:29:44 -06:00
* #860: Do not crash when encountering invalid doctest examples, just
emit a warning.
2014-09-19 06:18:29 -05:00
* #864: Fix crash with some settings of `modindex_common_prefix`.
2012-01-29 03:43:31 -06:00
2012-01-29 03:46:39 -06:00
* #862: Fix handling of ``-D`` and ``-A`` options on Python 3.
2012-01-29 04:13:49 -06:00
* #851: Recognize and warn about circular toctrees, instead of running
into recursion errors.
2012-01-29 04:20:12 -06:00
* #853: Restore compatibility with docutils trunk.
2012-01-29 04:24:25 -06:00
* #852: Fix HtmlHelp index entry links again.
2012-01-29 04:28:09 -06:00
* #854: Fix inheritance_diagram raising attribute errors on builtins.
2012-01-29 04:36:12 -06:00
* #832: Fix crashes when putting comments or lone terms in a glossary.
2012-01-29 05:03:30 -06:00
* #834, #818: Fix HTML help language/encoding mapping for all Sphinx
supported languages.
2012-01-29 04:47:22 -06:00
2012-01-29 04:58:23 -06:00
* #844: Fix crashes when dealing with Unicode output in doctest extension.
2012-01-29 05:02:30 -06:00
* #831: Provide ``--project`` flag in setup_command as advertised.
2012-03-10 11:47:33 -06:00
* #875: Fix reading config files under Python 3.
* #876: Fix quickstart test under Python 3.
2012-03-10 12:09:01 -06:00
* #870: Fix spurious KeyErrors when removing documents.
2012-03-10 12:24:03 -06:00
* #892: Fix single-HTML builder misbehaving with the master document in a
subdirectory.
2012-03-10 12:36:22 -06:00
* #873: Fix assertion errors with empty ``only`` directives.
2012-03-10 14:02:08 -06:00
* #816: Fix encoding issues in the Qt help builder.
2012-01-29 03:00:28 -06:00
2011-11-01 15:40:52 -05:00
Release 1.1.2 (Nov 1, 2011) -- 1.1.1 is a silly version number anyway!
======================================================================
* #809: Include custom fixers in the source distribution.
2011-11-01 09:24:26 -05:00
Release 1.1.1 (Nov 1, 2011)
===========================
2011-11-01 02:59:53 -05:00
2011-11-01 03:26:05 -05:00
* #791: Fix QtHelp, DevHelp and HtmlHelp index entry links.
2011-11-01 03:24:34 -05:00
2011-11-01 03:14:23 -05:00
* #792: Include "sphinx-apidoc" in the source distribution.
2011-11-01 03:09:50 -05:00
* #797: Don't crash on a misformatted glossary.
2011-11-01 03:01:48 -05:00
* #801: Make intersphinx work properly without SSL support.
2011-11-01 02:59:53 -05:00
* #805: Make the ``Sphinx.add_index_to_domain`` method work correctly.
* #780: Fix Python 2.5 compatibility.
2011-10-09 16:25:40 -05:00
Release 1.1 (Oct 9, 2011)
=========================
2010-07-24 05:35:29 -05:00
2011-01-16 02:40:05 -06:00
Incompatible changes
--------------------
2010-10-22 04:40:38 -05:00
2014-09-19 06:18:29 -05:00
* The `py:module` directive doesn't output its ``platform`` option
2011-01-16 02:40:05 -06:00
value anymore. (It was the only thing that the directive did output, and
therefore quite inconsistent.)
2011-01-07 12:00:29 -06:00
2011-09-25 01:31:27 -05:00
* Removed support for old dependency versions; requirements are now:
- Pygments >= 1.2
- Docutils >= 0.7
- Jinja2 >= 2.3
2011-01-16 02:40:05 -06:00
Features added
--------------
2011-01-06 11:29:37 -06:00
2011-01-16 02:40:05 -06:00
* Added Python 3.x support.
2011-01-15 04:33:45 -06:00
2011-01-16 02:40:05 -06:00
* New builders and subsystems:
- Added a Texinfo builder.
- Added i18n support for content, a ``gettext`` builder and related
utilities.
- Added the ``websupport`` library and builder.
- #98: Added a ``sphinx-apidoc`` script that autogenerates a hierarchy
of source files containing autodoc directives to document modules
and packages.
- #273: Add an API for adding full-text search support for languages
other than English. Add support for Japanese.
* Markup:
2011-09-22 02:29:36 -05:00
- #138: Added an :rst:role:`index` role, to make inline index entries.
- #454: Added more index markup capabilities: marking see/seealso entries,
2011-01-16 02:40:05 -06:00
and main entries for a given key.
2011-09-22 02:29:36 -05:00
- #460: Allowed limiting the depth of section numbers for HTML using the
2011-01-16 02:40:05 -06:00
:rst:dir:`toctree`\'s ``numbered`` option.
- #586: Implemented improved :rst:dir:`glossary` markup which allows
multiple terms per definition.
2014-09-19 06:18:29 -05:00
- #478: Added `py:decorator` directive to describe decorators.
2011-01-16 02:40:05 -06:00
- C++ domain now supports array definitions.
2011-09-22 03:37:55 -05:00
- C++ domain now supports doc fields (``:param x:`` inside directives).
2011-01-16 02:40:05 -06:00
- Section headings in :rst:dir:`only` directives are now correctly
handled.
2011-09-22 02:29:36 -05:00
- Added ``emphasize-lines`` option to source code directives.
2011-10-08 07:02:13 -05:00
- #678: C++ domain now supports superclasses.
2011-01-16 02:40:05 -06:00
* HTML builder:
- Added ``pyramid`` theme.
2014-09-19 06:18:29 -05:00
- #559: `html_add_permalinks` is now a string giving the
2011-01-16 02:40:05 -06:00
text to display in permalinks.
- #259: HTML table rows now have even/odd CSS classes to enable
"Zebra styling".
- #554: Add theme option ``sidebarwidth`` to the basic theme.
* Other builders:
2014-09-19 06:18:29 -05:00
- #516: Added new value of the `latex_show_urls` option to
2011-01-16 02:40:05 -06:00
show the URLs in footnotes.
2014-09-19 06:18:29 -05:00
- #209: Added `text_newlines` and `text_sectionchars`
2011-01-16 02:40:05 -06:00
config values.
2014-09-19 06:18:29 -05:00
- Added `man_show_urls` config value.
2011-01-16 02:40:05 -06:00
- #472: linkcheck builder: Check links in parallel, use HTTP HEAD
requests and allow configuring the timeout. New config values:
2014-09-19 06:18:29 -05:00
`linkcheck_timeout` and `linkcheck_workers`.
- #521: Added `linkcheck_ignore` config value.
2011-09-17 13:53:44 -05:00
- #28: Support row/colspans in tables in the LaTeX builder.
2011-01-16 02:40:05 -06:00
* Configuration and extensibility:
2014-09-19 06:18:29 -05:00
- #537: Added `nitpick_ignore`.
2011-01-16 02:40:05 -06:00
- #306: Added :event:`env-get-outdated` event.
2011-07-23 03:04:09 -05:00
- :meth:`.Application.add_stylesheet` now accepts full URIs.
2011-01-16 02:40:05 -06:00
* Autodoc:
2014-09-19 06:18:29 -05:00
- #564: Add `autodoc_docstring_signature`. When enabled (the
2011-01-16 02:40:05 -06:00
default), autodoc retrieves the signature from the first line of the
docstring, if it is found there.
- #176: Provide ``private-members`` option for autodoc directives.
- #520: Provide ``special-members`` option for autodoc directives.
- #431: Doc comments for attributes can now be given on the same line
as the assignment.
- #437: autodoc now shows values of class data attributes.
- autodoc now supports documenting the signatures of
``functools.partial`` objects.
* Other extensions:
- Added the :mod:`sphinx.ext.mathjax` extension.
- #443: Allow referencing external graphviz files.
- Added ``inline`` option to graphviz directives, and fixed the
default (block-style) in LaTeX output.
- #590: Added ``caption`` option to graphviz directives.
2014-09-19 06:18:29 -05:00
- #553: Added `testcleanup` blocks in the doctest extension.
- #594: `trim_doctest_flags` now also removes ``<BLANKLINE>``
2011-01-16 02:40:05 -06:00
indicators.
- #367: Added automatic exclusion of hidden members in inheritance
diagrams, and an option to selectively enable it.
2016-01-02 02:58:16 -06:00
- Added ``pngmath_add_tooltips``.
2011-06-30 02:08:21 -05:00
- The math extension displaymath directives now support ``name`` in
addition to ``label`` for giving the equation label, for compatibility
with Docutils.
2011-01-16 02:40:05 -06:00
* New locales:
- #221: Added Swedish locale.
- #526: Added Iranian locale.
2011-05-15 04:27:01 -05:00
- #694: Added Latvian locale.
2011-06-07 10:17:54 -05:00
- Added Nepali locale.
2011-09-21 02:25:37 -05:00
- #714: Added Korean locale.
2011-09-21 02:28:49 -05:00
- #766: Added Estonian locale.
2011-01-07 08:49:01 -06:00
2011-11-01 02:59:53 -05:00
* Bugs fixed:
2010-07-28 12:43:30 -05:00
2011-11-01 02:59:53 -05:00
- #778: Fix "hide search matches" link on pages linked by search.
- Fix the source positions referenced by the "viewcode" extension.
2011-10-07 12:17:01 -05:00
2011-09-23 15:07:48 -05:00
2011-09-23 00:58:45 -05:00
Release 1.0.8 (Sep 23, 2011)
2011-09-22 08:36:43 -05:00
============================
2011-01-15 10:21:18 -06:00
2011-09-23 03:46:43 -05:00
* #627: Fix tracebacks for AttributeErrors in autosummary generation.
2011-09-23 03:40:18 -05:00
* Fix the ``abbr`` role when the abbreviation has newlines in it.
2011-09-23 03:38:18 -05:00
* #727: Fix the links to search results with custom object types.
2011-09-23 02:46:24 -05:00
* #648: Fix line numbers reported in warnings about undefined
references.
2011-09-23 01:02:55 -05:00
* #696, #666: Fix C++ array definitions and template arguments
that are not type names.
2011-09-22 12:08:51 -05:00
* #633: Allow footnotes in section headers in LaTeX output.
2011-09-22 11:59:54 -05:00
* #616: Allow keywords to be linked via intersphinx.
2011-09-22 11:44:33 -05:00
* #613: Allow Unicode characters in production list token names.
2010-10-22 05:10:11 -05:00
2011-09-22 05:42:45 -05:00
* #720: Add dummy visitors for graphviz nodes for text and man.
2011-09-22 04:30:06 -05:00
* #704: Fix image file duplication bug.
2011-09-22 03:23:54 -05:00
* #677: Fix parsing of multiple signatures in C++ domain.
2011-09-22 02:46:46 -05:00
* #637: Ignore Emacs lock files when looking for source files.
* #544: Allow .pyw extension for importable modules in autodoc.
* #700: Use ``$(MAKE)`` in quickstart-generated Makefiles.
* #734: Make sidebar search box width consistent in browsers.
* #644: Fix spacing of centered figures in HTML output.
* #767: Safely encode SphinxError messages when printing them to
sys.stderr.
* #611: Fix LaTeX output error with a document with no sections but
a link target.
* Correctly treat built-in method descriptors as methods in autodoc.
* #706: Stop monkeypatching the Python textwrap module.
2011-05-15 06:31:39 -05:00
* #657: viewcode now works correctly with source files that have
non-ASCII encoding.
2011-05-15 06:00:11 -05:00
* #669: Respect the ``noindex`` flag option in py:module directives.
2011-05-15 05:31:33 -05:00
* #675: Fix IndexErrors when including nonexisting lines with
2014-09-19 06:18:29 -05:00
`literalinclude`.
2011-05-15 05:31:33 -05:00
2011-05-15 05:24:50 -05:00
* #676: Respect custom function/method parameter separator strings.
2011-05-15 05:20:47 -05:00
* #682: Fix JS incompatibility with jQuery >= 1.5.
2011-05-15 04:37:00 -05:00
* #693: Fix double encoding done when writing HTMLHelp .hhk files.
2011-05-15 04:34:52 -05:00
* #647: Do not apply SmartyPants in parsed-literal blocks.
2011-01-07 08:49:01 -06:00
* C++ domain now supports array definitions.
2011-01-15 10:21:18 -06:00
2011-01-15 09:25:43 -06:00
Release 1.0.7 (Jan 15, 2011)
============================
2011-01-04 16:52:30 -06:00
2011-01-15 08:10:30 -06:00
* #347: Fix wrong generation of directives of static methods in
autosummary.
2011-01-15 04:43:36 -06:00
* #599: Import PIL as ``from PIL import Image``.
2011-01-15 04:40:48 -06:00
* #558: Fix longtables with captions in LaTeX output.
2011-01-15 03:52:56 -06:00
* Make token references work as hyperlinks again in LaTeX output.
2011-01-08 09:41:15 -06:00
* #572: Show warnings by default when reference labels cannot be
found.
2011-01-08 09:04:19 -06:00
* #536: Include line number when complaining about missing reference
targets in nitpicky mode.
2011-01-08 08:15:25 -06:00
* #590: Fix inline display of graphviz diagrams in LaTeX output.
2011-01-07 17:28:53 -06:00
* #589: Build using app.build() in setup command.
2011-01-07 15:34:12 -06:00
* Fix a bug in the inheritance diagram exception that caused base
classes to be skipped if one of them is a builtin.
2011-01-07 11:58:23 -06:00
* Fix general index links for C++ domain objects.
2011-01-07 09:17:23 -06:00
* #332: Make admonition boundaries in LaTeX output visible.
2011-01-07 08:03:59 -06:00
* #573: Fix KeyErrors occurring on rebuild after removing a file.
2011-01-07 07:53:12 -06:00
* Fix a traceback when removing files with globbed toctrees.
2011-01-07 03:19:45 -06:00
* If an autodoc object cannot be imported, always re-read the
document containing the directive on next build.
* If an autodoc object cannot be imported, show the full traceback
of the import error.
2011-01-07 03:06:21 -06:00
* Fix a bug where the removal of download files and images wasn't
noticed.
2011-01-06 13:48:52 -06:00
* #571: Implement ``~`` cross-reference prefix for the C domain.
2011-01-06 11:28:42 -06:00
* Fix regression of LaTeX output with the fix of #556.
2011-01-06 06:03:17 -06:00
* #568: Fix lookup of class attribute documentation on descriptors
so that comment documentation now works.
2011-01-06 05:50:14 -06:00
* Fix traceback with ``only`` directives preceded by targets.
2011-01-06 05:28:55 -06:00
* Fix tracebacks occurring for duplicate C++ domain objects.
2011-01-15 07:27:13 -06:00
* Fix JavaScript domain links to objects with ``$`` in their name.
2011-01-04 16:52:30 -06:00
2011-01-04 16:43:29 -06:00
Release 1.0.6 (Jan 04, 2011)
============================
2010-11-17 14:17:51 -06:00
2011-01-04 16:39:13 -06:00
* #581: Fix traceback in Python domain for empty cross-reference
targets.
2011-01-04 16:20:59 -06:00
* #283: Fix literal block display issues on Chrome browsers.
2011-01-04 12:23:47 -06:00
* #383, #148: Support sorting a limited range of accented characters
in the general index and the glossary.
2011-01-04 10:14:00 -06:00
2011-01-04 08:33:18 -06:00
* #570: Try decoding ``-D`` and ``-A`` command-line arguments with
the locale's preferred encoding.
2014-09-19 06:18:29 -05:00
* #528: Observe `locale_dirs` when looking for the JS
2011-01-04 02:34:44 -06:00
translations file.
2011-01-03 16:13:40 -06:00
* #574: Add special code for better support of Japanese documents
in the LaTeX builder.
2011-01-03 16:08:13 -06:00
* Regression of #77: If there is only one parameter given with
``:param:`` markup, the bullet list is now suppressed again.
2011-01-03 14:38:30 -06:00
* #556: Fix missing paragraph breaks in LaTeX output in certain
situations.
2011-01-03 14:00:08 -06:00
* #567: Emit the ``autodoc-process-docstring`` event even for objects
without a docstring so that it can add content.
2011-01-03 13:48:11 -06:00
* #565: In the LaTeX builder, not only literal blocks require different
table handling, but also quite a few other list-like block elements.
2011-01-03 12:34:21 -06:00
* #515: Fix tracebacks in the viewcode extension for Python objects
that do not have a valid signature.
2014-06-19 11:14:47 -05:00
* Fix strange reports of line numbers for warnings generated from
2011-01-03 08:55:30 -06:00
autodoc-included docstrings, due to different behavior depending
on docutils version.
2010-11-17 14:17:51 -06:00
* Several fixes to the C++ domain.
2010-11-12 01:35:03 -06:00
Release 1.0.5 (Nov 12, 2010)
============================
2010-10-22 05:10:11 -05:00
2010-11-12 01:21:49 -06:00
* #557: Add CSS styles required by docutils 0.7 for aligned images
and figures.
2010-11-12 01:18:11 -06:00
* In the Makefile generated by LaTeX output, do not delete pdf files
on clean; they might be required images.
2010-10-22 05:10:11 -05:00
* #535: Fix LaTeX output generated for line blocks.
2010-08-23 12:13:23 -05:00
2010-10-22 02:40:03 -05:00
* #544: Allow ``.pyw`` as a source file extension.
2010-10-22 05:10:11 -05:00
Release 1.0.4 (Sep 17, 2010)
============================
2010-09-17 02:54:28 -05:00
* #524: Open intersphinx inventories in binary mode on Windows,
since version 2 contains zlib-compressed data.
2010-08-23 09:03:15 -05:00
2010-08-25 05:26:15 -05:00
* #513: Allow giving non-local URIs for JavaScript files, e.g.
in the JSMath extension.
2010-08-25 05:05:23 -05:00
* #512: Fix traceback when ``intersphinx_mapping`` is empty.
2010-08-23 12:13:23 -05:00
2010-08-23 12:06:44 -05:00
Release 1.0.3 (Aug 23, 2010)
============================
2010-08-23 09:03:15 -05:00
2010-08-23 11:04:28 -05:00
* #495: Fix internal vs. external link distinction for links coming
from a docutils table-of-contents.
2010-08-23 10:59:20 -05:00
* #494: Fix the ``maxdepth`` option for the ``toctree()`` template
callable when used with ``collapse=True``.
2010-08-23 10:20:22 -05:00
* #507: Fix crash parsing Python argument lists containing brackets
in string literals.
2010-08-23 09:54:17 -05:00
* #501: Fix regression when building LaTeX docs with figures that
don't have captions.
2010-08-23 09:03:15 -05:00
* #510: Fix inheritance diagrams for classes that are not picklable.
2010-08-23 11:11:26 -05:00
* #497: Introduce separate background color for the sidebar collapse
button, making it easier to see.
2010-08-23 10:23:08 -05:00
* #502, #503, #496: Fix small layout bugs in several builtin themes.
2010-08-23 09:54:17 -05:00
2010-08-23 09:03:15 -05:00
2010-08-14 10:09:23 -05:00
Release 1.0.2 (Aug 14, 2010)
2010-08-10 10:18:46 -05:00
============================
2010-07-24 05:35:29 -05:00
2010-08-14 09:51:04 -05:00
* #490: Fix cross-references to objects of types added by the
:func:`~.Sphinx.add_object_type` API function.
2010-08-14 10:04:25 -05:00
* Fix handling of doc field types for different directive types.
2010-08-05 09:03:36 -05:00
* Allow breaking long signatures, continuing with backlash-escaped
newlines.
* Fix unwanted styling of C domain references (because of a namespace
clash with Pygments styles).
2010-08-05 08:47:10 -05:00
2010-08-05 08:42:15 -05:00
* Allow references to PEPs and RFCs with explicit anchors.
2010-08-05 08:07:44 -05:00
* #471: Fix LaTeX references to figures.
2010-08-05 06:39:23 -05:00
* #482: When doing a non-exact search, match only the given type
of object.
* #481: Apply non-exact search for Python reference targets with
``.name`` for modules too.
2010-08-05 05:53:05 -05:00
* #484: Fix crash when duplicating a parameter in an info field list.
2010-08-05 05:03:45 -05:00
* #487: Fix setting the default role to one provided by the
``oldcmarkup`` extension.
2010-08-05 05:02:27 -05:00
* #488: Fix crash when json-py is installed, which provides a
``json`` module but is incompatible to simplejson.
2010-08-05 04:58:43 -05:00
* #480: Fix handling of target naming in intersphinx.
2010-08-05 03:14:10 -05:00
* #486: Fix removal of ``!`` for all cross-reference roles.
2010-07-27 12:40:19 -05:00
Release 1.0.1 (Jul 27, 2010)
============================
2010-07-24 05:30:37 -05:00
2010-07-27 07:45:17 -05:00
* #470: Fix generated target names for reST domain objects; they
are not in the same namespace.
2010-07-27 07:36:47 -05:00
* #266: Add Bengali language.
2010-07-27 07:28:31 -05:00
* #473: Fix a bug in parsing JavaScript object names.
* #474: Fix building with SingleHTMLBuilder when there is no toctree.
2010-07-27 06:27:00 -05:00
2010-07-27 06:20:58 -05:00
* Fix display names for objects linked to by intersphinx with
explicit targets.
2010-07-25 07:52:37 -05:00
* Fix building with the JSON builder.
2010-07-24 05:30:37 -05:00
* Fix hyperrefs in object descriptions for LaTeX.
2010-07-23 06:42:03 -05:00
Release 1.0 (Jul 23, 2010)
==========================
2009-03-24 15:54:05 -05:00
2010-05-24 06:28:12 -05:00
Incompatible changes
--------------------
2010-01-17 17:38:30 -06:00
* Support for domains has been added. A domain is a collection of
directives and roles that all describe objects belonging together,
2010-05-24 06:28:12 -05:00
e.g. elements of a programming language. A few builtin domains are
provided:
- Python
- C
- C++
- JavaScript
- reStructuredText
2010-07-02 04:44:01 -05:00
* The old markup for defining and linking to C directives is now
deprecated. It will not work anymore in future versions without
activating the :mod:`~sphinx.ext.oldcmarkup` extension; in Sphinx
1.0, it is activated by default.
2010-05-24 06:28:12 -05:00
* Removed support for old dependency versions; requirements are now:
- docutils >= 0.5
- Jinja2 >= 2.2
* Removed deprecated elements:
- ``exclude_dirs`` config value
- ``sphinx.builder`` module
Features added
--------------
* General:
- Added a "nitpicky" mode that emits warnings for all missing
2016-01-11 22:36:12 -06:00
references. It is activated by the :option:`sphinx-build -n` command-line switch
2014-09-19 06:18:29 -05:00
or the `nitpicky` config value.
2010-05-24 06:28:12 -05:00
- Added ``latexpdf`` target in quickstart Makefile.
* Markup:
2014-09-19 06:18:29 -05:00
- The `menuselection` and `guilabel` roles now
2010-05-30 10:33:37 -05:00
support ampersand accelerators.
2010-05-24 06:28:12 -05:00
- New more compact doc field syntax is now recognized: ``:param type
name: description``.
2014-09-19 06:18:29 -05:00
- Added ``tab-width`` option to `literalinclude` directive.
2010-05-30 10:33:37 -05:00
- Added ``titlesonly`` option to :rst:dir:`toctree` directive.
2010-05-24 06:28:12 -05:00
- Added the ``prepend`` and ``append`` options to the
2014-09-19 06:18:29 -05:00
`literalinclude` directive.
2010-05-24 06:28:12 -05:00
- #284: All docinfo metadata is now put into the document metadata, not
just the author.
2014-09-19 06:18:29 -05:00
- The `ref` role can now also reference tables by caption.
- The :dudir:`include` directive now supports absolute paths, which
2010-05-30 10:33:37 -05:00
are interpreted as relative to the source directory.
2010-06-12 03:41:56 -05:00
- In the Python domain, references like ``:func:`.name``` now look for
matching names with any prefix if no direct match is found.
2010-05-24 06:28:12 -05:00
* Configuration:
2014-09-19 06:18:29 -05:00
- Added `rst_prolog` config value.
- Added `html_secnumber_suffix` config value to control
2010-05-30 10:33:37 -05:00
section numbering format.
2014-09-19 06:18:29 -05:00
- Added `html_compact_lists` config value to control
2010-05-30 10:33:37 -05:00
docutils' compact lists feature.
2014-09-19 06:18:29 -05:00
- The `html_sidebars` config value can now contain patterns
2010-05-30 10:33:37 -05:00
as keys, and the values can be lists that explicitly select which
2010-05-24 06:28:12 -05:00
sidebar templates should be rendered. That means that the builtin
sidebar contents can be included only selectively.
2014-09-19 06:18:29 -05:00
- `html_static_path` can now contain single file entries.
- The new universal config value `exclude_patterns` makes the
old ``unused_docs``, ``exclude_trees`` and
``exclude_dirnames`` obsolete.
- Added `html_output_encoding` config value.
- Added the `latex_docclass` config value and made the
2010-05-30 10:33:37 -05:00
"twoside" documentclass option overridable by "oneside".
2014-09-19 06:18:29 -05:00
- Added the `trim_doctest_flags` config value, which is true
2010-05-30 10:33:37 -05:00
by default.
2014-09-19 06:18:29 -05:00
- Added `html_show_copyright` config value.
- Added `latex_show_pagerefs` and `latex_show_urls`
2010-05-30 10:33:37 -05:00
config values.
2014-09-19 06:18:29 -05:00
- The behavior of `html_file_suffix` changed slightly: the
2010-07-17 12:45:54 -05:00
empty string now means "no suffix" instead of "default suffix", use
``None`` for "default suffix".
2010-05-24 06:28:12 -05:00
* New builders:
- Added a builder for the Epub format.
- Added a builder for manual pages.
- Added a single-file HTML builder.
* HTML output:
- Inline roles now get a CSS class with their name, allowing styles to
customize their appearance. Domain-specific roles get two classes,
``domain`` and ``domain-rolename``.
- References now get the class ``internal`` if they are internal to
the whole project, as opposed to internal to the current page.
2010-05-24 16:14:35 -05:00
- External references can be styled differently with the new
``externalrefs`` theme option for the default theme.
- In the default theme, the sidebar can experimentally now be made
collapsible using the new ``collapsiblesidebar`` theme option.
2010-05-24 06:28:12 -05:00
- #129: Toctrees are now wrapped in a ``div`` tag with class
``toctree-wrapper`` in HTML output.
2010-05-30 10:33:37 -05:00
- The :data:`toctree` callable in templates now has a ``maxdepth``
2010-05-24 06:28:12 -05:00
keyword argument to control the depth of the generated tree.
2010-05-30 10:33:37 -05:00
- The :data:`toctree` callable in templates now accepts a
``titles_only`` keyword argument.
2010-05-24 06:28:12 -05:00
- Added ``htmltitle`` block in layout template.
- In the JavaScript search, allow searching for object names including
the module name, like ``sys.argv``.
- Added new theme ``haiku``, inspired by the Haiku OS user guide.
- Added new theme ``nature``.
- Added new theme ``agogo``, created by Andi Albrecht.
- Added new theme ``scrolls``, created by Armin Ronacher.
- #193: Added a ``visitedlinkcolor`` theme option to the default
theme.
2010-05-30 08:50:00 -05:00
- #322: Improved responsiveness of the search page by loading the
search index asynchronously.
2010-05-24 06:28:12 -05:00
* Extension API:
2010-05-30 10:33:37 -05:00
- Added :event:`html-collect-pages`.
2014-09-19 06:18:29 -05:00
- Added `needs_sphinx` config value and
2010-05-30 10:33:37 -05:00
:meth:`~sphinx.application.Sphinx.require_sphinx` application API
method.
- #200: Added :meth:`~sphinx.application.Sphinx.add_stylesheet`
application API method.
2010-05-24 06:28:12 -05:00
* Extensions:
2010-05-30 10:33:37 -05:00
- Added the :mod:`~sphinx.ext.viewcode` extension.
- Added the :mod:`~sphinx.ext.extlinks` extension.
2010-05-24 06:28:12 -05:00
- Added support for source ordering of members in autodoc, with
``autodoc_member_order = 'bysource'``.
2014-09-19 06:18:29 -05:00
- Added `autodoc_default_flags` config value, which can be
2010-05-30 10:33:37 -05:00
used to select default flags for all autodoc directives.
2010-05-24 06:28:12 -05:00
- Added a way for intersphinx to refer to named labels in other
projects, and to specify the project you want to link to.
- #280: Autodoc can now document instance attributes assigned in
``__init__`` methods.
2010-05-30 10:33:37 -05:00
- Many improvements and fixes to the :mod:`~sphinx.ext.autosummary`
extension, thanks to Pauli Virtanen.
- #309: The :mod:`~sphinx.ext.graphviz` extension can now output SVG
instead of PNG images, controlled by the
2014-09-19 06:18:29 -05:00
`graphviz_output_format` config value.
2010-05-30 10:33:37 -05:00
- Added ``alt`` option to :rst:dir:`graphviz` extension directives.
2010-06-12 11:16:18 -05:00
- Added ``exclude`` argument to :func:`.autodoc.between`.
2010-05-24 06:28:12 -05:00
* Translations:
- Added Croatian translation, thanks to Bojan Mihelač.
- Added Turkish translation, thanks to Firat Ozgul.
- Added Catalan translation, thanks to Pau Fernández.
- Added simplified Chinese translation.
2010-06-05 08:42:18 -05:00
- Added Danish translation, thanks to Hjorth Larsen.
2010-06-20 05:19:34 -05:00
- Added Lithuanian translation, thanks to Dalius Dobravolskas.
2009-11-08 12:03:57 -06:00
2010-08-25 07:05:36 -05:00
* Bugs fixed:
2009-04-13 03:45:52 -05:00
2010-08-25 07:05:36 -05:00
- #445: Fix links to result pages when using the search function
of HTML built with the ``dirhtml`` builder.
- #444: In templates, properly re-escape values treated with the
"striptags" Jinja filter.
2010-06-13 12:50:04 -05:00
2013-03-29 07:05:49 -05:00
Previous versions
=================
2008-03-22 15:44:56 -05:00
2013-03-29 07:05:49 -05:00
The changelog for versions before 1.0 can be found in the file ``CHANGES.old``
2015-01-02 06:49:38 -06:00
in the source distribution or `at Github
<https://github.com/sphinx-doc/sphinx/raw/master/CHANGES.old>`__.
