Sphinx 1.4 released

47 views
Skip to first unread message

Takayuki Shimizukawa

unread,
Mar 28, 2016, 10:38:57 AM3/28/16
to sphinx...@googlegroups.com
Hi all,

I'm very happy to announce the release of Sphinx 1.4-final available on the Python package index at <http://pypi.python.org/pypi/Sphinx/1.4>.

Sphinx-1.4 includes many updates from 1.3.6 version:

* 49 features
* 17 incompatible changes
* 40 fixes of bugs/buglets

For the full changelog, go to <http://www.sphinx-doc.org/en/1.4/changes.html>.
Thanks to all coraborators and contributers!

What's new in 1.4 (short version)?
=================================

Features added
--------------

* I18N: figure substitutions by language and figure_language_filename
* Config: suppress_warnings to suppress arbitrary warning message (experimental)
* Directive: glossary term supports grouping key for index entries by using classifier syntax (experimental)
* Directive: Support Imgmath (pngmath with svg support).
* Builder: XeTeX and LuaTeX for the LaTeX builder.
* Builder: Add the ``dummy`` builder: syntax check without output.
* Builder: Add EPUB 3 builder (experimental)
* Search: Chinese language search index.
* Search: Japanese language search index by using Janome
* Search: splitter customization for Japanese language search index
* Domain: cpp domain improvements
* Ext: Add sphinx.ext.githubpages to publish the docs on GitHub Pages
* Ext: Add ``sphinx.ext.autosectionlabel`` extension to allow reference
  sections using its title.
* API: Add Sphinx.add_source_parser() to add source_suffix and source_parsers from extension
* Image recognition by using  ``imagesize`` package w/o PIL/Pillow


Incompatible changes
--------------------

* manpage writer: don't make whole of item in definition list bold if it includes strong node.
* Remove hint message from quick search box for html output.
* sphinx_rtd_theme has become optional. Please install it manually.
* :confval:`html_extra_path` also copies dotfiles in the extra directory, and
  refers to :confval:`exclude_patterns` to exclude extra files and directories.
* Under glossary directive, each terms are converted into individual ``term`` nodes and ``termsep`` node is removed.
  By this change, output layout of every builders are changed a bit.
* The default highlight language is now Python 3.  This means that source code
  is highlighted as Python 3 (which is mostly a superset of Python 2), and no
  parsing is attempted to distinguish valid code.
* `Locale Date Markup Language
  ``"MMMM dd, YYYY"`` is default forma 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.

What is it?
===========

Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects (or other documents consisting of
multiple reStructuredText source files).

IRC: #sphinx-doc on irc.freenode.net

Enjoy!
--
Takayuki SHIMIZUKAWA

Reply all
Reply to author
Forward
0 new messages