Sphinx

Latest version: v7.3.7

Safety actively analyzes 638418 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 31 of 33

0.6.3

Not secure
============================

* Properly add C module filenames as dependencies in autodoc.

* 253: Ignore graphviz directives without content instead of
raising an unhandled exception.

* 241: Fix a crash building LaTeX output for documents that contain
a todolist directive.

* 252: Make it easier to change the build dir in the Makefiles
generated by quickstart.

* 220: Fix CSS so that displaymath really is centered.

* 222: Allow the "Footnotes" header to be translated.

* 225: Don't add whitespace in generated HTML after inline tags.

* 227: Make ``literalinclude`` work when the document's path
name contains non-ASCII characters.

* 229: Fix autodoc failures with members that raise errors
on ``getattr()``.

* 205: When copying files, don't copy full stat info, only
modification times.

* 232: Support non-ASCII metadata in Qt help builder.

* Properly format bullet lists nested in definition lists for LaTeX.

* Section titles are now allowed inside ``only`` directives.

* 201: Make ``centered`` directive work in LaTeX output.

* 206: Refuse to overwrite an existing master document in
sphinx-quickstart.

* 208: Use MS-sanctioned locale settings, determined by the
``language`` config option, in the HTML help builder.

* 210: Fix nesting of HTML tags for displayed math from pngmath
extension.

* 213: Fix centering of images in LaTeX output.

* 211: Fix compatibility with Docutils 0.5.

0.6.2

Not secure
============================

* 130: Fix obscure IndexError in doctest extension.

* 167: Make glossary sorting case-independent.

* 196: Add a warning if an extension module doesn't have a
``setup()`` function.

* 158: Allow '..' in template names, and absolute template paths;
Jinja 2 by default disables both.

* When highlighting Python code, ignore extra indentation before
trying to parse it as Python.

* 191: Don't escape the tilde in URIs in LaTeX.

* Don't consider contents of source comments for the search index.

* Set the default encoding to ``utf-8-sig`` to handle files with a
UTF-8 BOM correctly.

* 178: apply ``add_function_parentheses`` config value to C
functions as promised.

* 173: Respect the Docutils ``title`` directive.

* 172: The ``obj`` role now links to modules as promised.

* 19: Tables now can have a "longtable" class, in order to get
correctly broken into pages in LaTeX output.

* Look for Sphinx message catalogs in the system default path before
trying ``sphinx/locale``.

* Fix the search for methods via "classname.methodname".

* 155: Fix Python 2.4 compatibility: exceptions are old-style
classes there.

* 150: Fix display of the "sphinxdoc" theme on Internet Explorer
versions 6 and 7.

* 146: Don't fail to generate LaTeX when the user has an active
``.docutils`` configuration.

* 29: Don't generate visible "-{-}" in option lists in LaTeX.

* Fix cross-reference roles when put into substitutions.

* Don't put image "alt" text into table-of-contents entries.

* In the LaTeX writer, do not raise an exception on too many section
levels, just use the "subparagraph" level for all of them.

* 145: Fix autodoc problem with automatic members that refuse to be
getattr()'d from their parent.

* If specific filenames to build are given on the command line,
check that they are within the source directory.

* Fix autodoc crash for objects without a ``__name__``.

* Fix intersphinx for installations without urllib2.HTTPSHandler.

* 134: Fix pending_xref leftover nodes when using the todolist
directive from the todo extension.

0.6.1

Not secure
============================

* 135: Fix problems with LaTeX output and the graphviz extension.

* 132: Include the autosummary "module" template in the distribution.

0.6

Not secure
==========================

New features added
------------------

* Incompatible changes:

- Templating now requires the Jinja2 library, which is an enhanced
version of the old Jinja1 engine. Since the syntax and semantic
is largely the same, very few fixes should be necessary in
custom templates.

- The "document" div tag has been moved out of the ``layout.html``
template's "document" block, because the closing tag was already
outside. If you overwrite this block, you need to remove your
"document" div tag as well.

- The ``autodoc_skip_member`` event now also gets to decide
whether to skip members whose name starts with underscores.
Previously, these members were always automatically skipped.
Therefore, if you handle this event, add something like this
to your event handler to restore the old behavior::

if name.startswith('_'):
return True

* Theming support, see the new section in the documentation.

* Markup:

- Due to popular demand, added a ``:doc:`` role which directly
links to another document without the need of creating a
label to which a ``:ref:`` could link to.

- 4: Added a ``:download:`` role that marks a non-document file
for inclusion into the HTML output and links to it.

- Added an ``only`` directive that can selectively include text
based on enabled "tags". Tags can be given on the command
line. Also, the current builder output format (e.g. "html" or
"latex") is always a defined tag.

- 10: Added HTML section numbers, enabled by giving a
``:numbered:`` flag to the ``toctree`` directive.

- 114: Added an ``abbr`` role to markup abbreviations and
acronyms.

- The ``literalinclude`` directive now supports several more
options, to include only parts of a file.

- The ``toctree`` directive now supports a ``:hidden:`` flag,
which will prevent links from being generated in place of
the directive -- this allows you to define your document
structure, but place the links yourself.

- 123: The ``glossary`` directive now supports a ``:sorted:``
flag that sorts glossary entries alphabetically.

- Paths to images, literal include files and download files
can now be absolute (like ``/images/foo.png``). They are
treated as relative to the top source directory.

- 52: There is now a ``hlist`` directive, creating a compact
list by placing distributing items into multiple columns.

- 77: If a description environment with info field list only
contains one ``:param:`` entry, no bullet list is generated.

- 6: Don't generate redundant ``<ul>`` for top-level TOC tree
items, which leads to a visual separation of TOC entries.

- 23: Added a ``classmethod`` directive along with ``method``
and ``staticmethod``.

- Scaled images now get a link to the unscaled version.

- SVG images are now supported in HTML (via ``<object>`` and
``<embed>`` tags).

- Added a ``toctree`` callable to the templates, and the ability
to include external links in toctrees. The 'collapse' keyword
argument indicates whether or not to only display subitems of
the current page. (Defaults to ``True``.)

* Configuration:

- The new config value ``rst_epilog`` can contain reST that is
appended to each source file that is read. This is the right
place for global substitutions.

- The new ``html_add_permalinks`` config value can be used to
switch off the generated "paragraph sign" permalinks for each
heading and definition environment.

- The new ``html_show_sourcelink`` config value can be used to
switch off the links to the reST sources in the sidebar.

- The default value for ``htmlhelp_basename`` is now the project
title, cleaned up as a filename.

- The new ``modindex_common_prefix`` config value can be used to
ignore certain package names for module index sorting.

- The new ``trim_footnote_reference_space`` config value mirrors
the Docutils config value of the same name and removes the
space before a footnote reference that is necessary for reST
to recognize the reference.

- The new ``latex_additional_files`` config value can be used to
copy files (that Sphinx doesn't copy automatically, e.g. if they
are referenced in custom LaTeX added in ``latex_elements``) to
the build directory.

* Builders:

- The HTML builder now stores a small file named ``.buildinfo`` in
its output directory. It stores a hash of config values that
can be used to determine if a full rebuild needs to be done (e.g.
after changing ``html_theme``).

- New builder for Qt help collections, by Antonio Valentino.

- The new ``DirectoryHTMLBuilder`` (short name ``dirhtml``) creates
a separate directory for every page, and places the page there
in a file called ``index.html``. Therefore, page URLs and links
don't need to contain ``.html``.

- The new ``html_link_suffix`` config value can be used to select
the suffix of generated links between HTML files.

- 96: The LaTeX builder now supports figures wrapped by text, when
using the ``figwidth`` option and right/left alignment.

* New translations:

- Italian by Sandro Dentella.
- Ukrainian by Petro Sasnyk.
- Finnish by Jukka Inkeri.
- Russian by Alexander Smishlajev.

* Extensions and API:

- New ``graphviz`` extension to embed graphviz graphs.

- New ``inheritance_diagram`` extension to embed... inheritance
diagrams!

- New ``autosummary`` extension that generates summaries of
modules and automatic documentation of modules.

- Autodoc now has a reusable Python API, which can be used to
create custom types of objects to auto-document (e.g. Zope
interfaces). See also ``Sphinx.add_autodocumenter()``.

- Autodoc now handles documented attributes.

- Autodoc now handles inner classes and their methods.

- Autodoc can document classes as functions now if explicitly
marked with ``autofunction``.

- Autodoc can now exclude single members from documentation
via the ``exclude-members`` option.

- Autodoc can now order members either alphabetically (like
previously) or by member type; configurable either with the
config value ``autodoc_member_order`` or a ``member-order``
option per directive.

- The function ``Sphinx.add_directive()`` now also supports
Docutils 0.5-style directive classes. If they inherit from
``sphinx.util.compat.Directive``, they also work with
Docutils 0.4.

- There is now a ``Sphinx.add_lexer()`` method to be able to use
custom Pygments lexers easily.

- There is now ``Sphinx.add_generic_role()`` to mirror the
Docutils' own function.

* Other changes:

- Config overrides for single dict keys can now be given on the
command line.

- There is now a ``doctest_global_setup`` config value that can
be used to give setup code for all doctests in the documentation.

- Source links in HTML are now generated with ``rel="nofollow"``.

- Quickstart can now generate a Windows ``make.bat`` file.

- 62: There is now a ``-w`` option for sphinx-build that writes
warnings to a file, in addition to stderr.

- There is now a ``-W`` option for sphinx-build that turns warnings
into errors.

0.5.2

Not secure
============================

* Properly escape ``|`` in LaTeX output.

* 71: If a decoding error occurs in source files, print a
warning and replace the characters by "?".

* Fix a problem in the HTML search if the index takes too long
to load.

* Don't output system messages while resolving, because they
would stay in the doctrees even if keep_warnings is false.

* 82: Determine the correct path for dependencies noted by
docutils. This fixes behavior where a source with dependent
files was always reported as changed.

* Recognize toctree directives that are not on section toplevel,
but within block items, such as tables.

* Use a new RFC base URL, since rfc.org seems down.

* Fix a crash in the todolist directive when no todo items are
defined.

* Don't call LaTeX or dvipng over and over again if it was not
found once, and use text-only latex as a substitute in that case.

* Fix problems with footnotes in the LaTeX output.

* Prevent double hyphens becoming en-dashes in literal code in
the LaTeX output.

* Open literalinclude files in universal newline mode to allow
arbitrary newline conventions.

* Actually make the ``-Q`` option work.

* 86: Fix explicit document titles in toctrees.

* 81: Write environment and search index in a manner that is safe
from exceptions that occur during dumping.

* 80: Fix UnicodeErrors when a locale is set with setlocale().

0.5.1

Not secure
============================

* 67: Output warnings about failed doctests in the doctest extension
even when running in quiet mode.

* 72: In pngmath, make it possible to give a full path to LaTeX and
dvipng on Windows. For that to work, the ``pngmath_latex`` and
``pngmath_dvipng`` options are no longer split into command and
additional arguments; use ``pngmath_latex_args`` and
``pngmath_dvipng_args`` to give additional arguments.

* Don't crash on failing doctests with non-ASCII characters.

* Don't crash on writing status messages and warnings containing
unencodable characters.

* Warn if a doctest extension block doesn't contain any code.

* Fix the handling of ``:param:`` and ``:type:`` doc fields when
they contain markup (especially cross-referencing roles).

* 65: Fix storage of depth information for PNGs generated by the
pngmath extension.

* Fix autodoc crash when automethod is used outside a class context.

* 68: Fix LaTeX writer output for images with specified height.

* 60: Fix wrong generated image path when including images in sources
in subdirectories.

* Fix the JavaScript search when html_copy_source is off.

* Fix an indentation problem in autodoc when documenting classes
with the option ``autoclass_content = "both"`` set.

* Don't crash on empty index entries, only emit a warning.

* Fix a typo in the search JavaScript code, leading to unusable
search function in some setups.

Page 31 of 33

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.