IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Group changelog entries and fix docstring for jsdump.

Browse Source
This commit is contained in:
Georg Brandl
2008-09-24 12:20:41 +00:00
parent 0970f31caa
commit dfee8188b3
2 changed files with 76 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
CHANGES
View File

@@ -4,82 +4,97 @@ Release 0.5 (in development)
New features added New features added
------------------ ------------------
* The JavaScript search now searches for objects before searching * HTML output and templates:
in the full text.
* The new extensions ``sphinx.ext.jsmath`` and ``sphinx.ext.pngmath`` - Incompatible change: The "root" relation link (top left in the
provide math support for both HTML and LaTeX builders. relbar) now points to the ``master_doc`` by default, no longer to a
document called "index". The old behavior, while useful in some
situations, was somewhat unexpected.
* The new extension ``sphinx.ext.intersphinx`` half-automatically - The JavaScript search now searches for objects before searching in
creates links to Sphinx documentation of Python objects in other the full text.
projects.
* Added support for internationalization in generated text with the - ``SerializingHTMLBuilder`` was added as new abstract builder that
``language`` and ``locale_dirs`` config values. Many thanks to can be subclassed to serialize build HTML in a specific format. The
Horst Gutmann, who also contributed German as the first language. ``PickleHTMLBuilder`` is a concrete subclass of it that uses pickle
A Czech translation was provided by Pavel Kosina. A French as serialization implementation.
translation was provided by David Larlet. A Polish translation
was provided by Michał Kandulski. A Japanese translation was
provided by Yasushi Masuda.
* Added a distutils command `build_sphinx`: When Sphinx is installed, - ``JSONHTMLBuilder`` was added as another ``SerializingHTMLBuilder``
you can call ``python setup.py build_sphinx`` for projects that
have Sphinx documentation, which will build the docs and place them
in the standard distutils build directory.
* "System Message" warnings are now automatically removed from the
built documentation, and only written to stderr. If you want the
old behavior, set the new config value ``keep_warnings`` to True.
* The new config value ``highlight_language`` set a global default
for highlighting. When ``'python3'`` is selected, console output
blocks are recognized like for ``'python'``.
* The new config value ``latex_elements`` allows to override all
LaTeX snippets that Sphinx puts into the generated .tex file by
default.
* ``SerializingHTMLBuilder`` was added as new abstract builder that
can be subclassed to serialize build HTML in a specific format.
The ``PickleHTMLBuilder`` is a concrete subclass of it that uses
pickle as serialization implementation.
* ``JSONHTMLBuilder`` was added as another ``SerializingHTMLBuilder``
subclass that dumps the generated HTML into JSON files for further subclass that dumps the generated HTML into JSON files for further
processing. processing.
* The `automodule` directive now supports the ``synopsis``, - The ``rellinks`` block in the layout template is now called
``deprecated`` and ``platform`` options. ``linktags`` to avoid confusion with the relbar links.
* The HTML builders have two additional attributes now that can be - The HTML builders have two additional attributes now that can be
used to disable the anchor-link creation after headlines and used to disable the anchor-link creation after headlines and
definition links. definition links.
* sphinx.doc.autodoc has a new event ``autodoc-process-signature`` * New and changed config values:
that allows tuning function signature introspection.
* Respect __all__ when autodocumenting module members. - Added support for internationalization in generated text with the
``language`` and ``locale_dirs`` config values. Many thanks to
language contributors:
* Glossary entries are now automatically added to the index. * Horst Gutmann -- German
* Pavel Kosina -- Czech
* David Larlet -- French
* Michał Kandulski -- Polish
* Yasushi Masuda -- Japanese
* Added ``exclude_dirnames`` config value that can be used to exclude - The new config value ``highlight_language`` set a global default for
highlighting. When ``'python3'`` is selected, console output blocks
are recognized like for ``'python'``.
- Exposed Pygments' lexer guessing as a highlight "language" ``guess``.
- The new config value ``latex_elements`` allows to override all LaTeX
snippets that Sphinx puts into the generated .tex file by default.
- Added ``exclude_dirnames`` config value that can be used to exclude
e.g. CVS directories from source file search. e.g. CVS directories from source file search.
* ``Sphinx.add_node()`` now takes optional visitor methods for the * Extensions:
- The new extensions ``sphinx.ext.jsmath`` and ``sphinx.ext.pngmath``
provide math support for both HTML and LaTeX builders.
- The new extension ``sphinx.ext.intersphinx`` half-automatically
creates links to Sphinx documentation of Python objects in other
projects.
- sphinx.doc.autodoc has a new event ``autodoc-process-signature``
that allows tuning function signature introspection.
- Respect __all__ when autodocumenting module members.
- The `automodule` directive now supports the ``synopsis``,
``deprecated`` and ``platform`` options.
* Extension API:
- ``Sphinx.add_node()`` now takes optional visitor methods for the
HTML, LaTeX and text translators; this prevents having to manually HTML, LaTeX and text translators; this prevents having to manually
patch the classes. patch the classes.
* Exposed Pygments' lexer guessing as a highlight "language" - Added ``Sphinx.add_javascript()`` that adds scripts to load in the
``guess``.
* Added ``Sphinx.add_javascript()`` that adds scripts to load in the
default HTML template. default HTML template.
* Added new events: ``env-updated``, ``missing-reference``, - Added new events: ``env-updated``, ``missing-reference``,
``build-finished``. ``build-finished``.
* The ``rellinks`` block in the layout template is now called * Other changes:
``linktags`` to avoid confusion with the relbar links.
- Added a distutils command `build_sphinx`: When Sphinx is installed,
you can call ``python setup.py build_sphinx`` for projects that have
Sphinx documentation, which will build the docs and place them in
the standard distutils build directory.
- "System Message" warnings are now automatically removed from the
built documentation, and only written to stderr. If you want the
old behavior, set the new config value ``keep_warnings`` to True.
- Glossary entries are now automatically added to the index.
Release 0.4.2 (Jul 29, 2008) Release 0.4.2 (Jul 29, 2008)

11
sphinx/util/jsdump.py
View File

@@ -1,14 +1,9 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
""" """
sphinx.util.json sphinx.util.jsdump
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
This module implements a simple JSON serializer if simplejson is
unavailable.
This is not fully JSON compliant but enough for the searchindex.
And the generated files are smaller than the simplejson ones.
This module implements a simple JavaScript serializer.
Uses the basestring encode function from simplejson. Uses the basestring encode function from simplejson.
:copyright: 2008 by Armin Ronacher, Bob Ippolito, Georg Brandl. :copyright: 2008 by Armin Ronacher, Bob Ippolito, Georg Brandl.