Sphinx

Latest version: v7.3.7

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

Scan your dependencies

Page 27 of 33

1.3b3

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

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

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

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

* 1346: Add new default theme;

* Add '``alabaster``' theme.
* Add '``sphinx_rtd_theme``' theme.
* The 'default' html theme has been renamed to 'classic'. 'default' is still
available, however it will emit notice a recommendation that using new
'``alabaster``' theme.

* Added ``highlight_options`` configuration value.
* The ``language`` config value is now available in the HTML templates.
* The ``env-updated`` event can now return a value, which is interpreted
as an iterable of additional docnames that need to be rewritten.
* 772: Support for scoped and unscoped enums in C++. Enumerators in unscoped
enums are injected into the parent scope in addition to the enum scope.
* Add ``todo_include_todos`` config option to quickstart conf file, handled as
described in documentation.
* HTML breadcrumb items tag has class "nav-item" and "nav-item-N" (like
nav-item-0, 1, 2...).
* New option ``sphinx-quickstart --use-make-mode`` for generating Makefile that
use sphinx-build make-mode.
* 1235: i18n: several node can be translated if it is set to
``gettext_additional_targets`` in conf.py. Supported nodes are:

- 'literal-block'
- 'doctest-block'
- 'raw'
- 'image'

* 1227: Add ``html_scaled_image_link`` config option to conf.py, to control
scaled image link.

Bugs fixed
----------

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

1.3b2

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

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

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

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

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

Bugs fixed
----------

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

1.3b1

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

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

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

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

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

Bugs fixed
----------

* 1438: Updated jQuery version from 1.8.3 to 1.11.1.
* 1568: Fix a crash when a "centered" directive contains a reference.
* Now sphinx.ext.autodoc works with python-2.5 again.
* 1563: :meth:`~sphinx.application.Sphinx.add_search_language` raises
AssertionError for correct type of argument. Thanks to rikoman.
* 1174: Fix smart quotes being applied inside roles like :rst:role:`program` or
``makevar``.
* PR235: comment db schema of websupport lacked a length of the node_id field.
Thanks to solos.
* 1466,PR241: Fix failure of the cpp domain parser to parse C+11
"variadic templates" declarations. Thanks to Victor Zverovich.
* 1459,PR244: Fix default mathjax js path point to ``http://`` that cause
mixed-content error on HTTPS server. Thanks to sbrandtb and robo9k.
* PR157: autodoc remove spurious signatures from property decorated
attributes. Thanks to David Ham.
* PR159: Add coverage targets to quickstart generated Makefile and make.bat.
Thanks to Matthias Troffaes.
* 1251: When specifying toctree :numbered: option and :tocdepth: metadata,
sub section number that is larger depth than ``:tocdepth:`` is shrunk.
* PR260: Encode underscore in citation labels for latex export. Thanks to
Lennart Fricke.
* PR264: Fix could not resolve xref for figure node with :name: option.
Thanks to Takeshi Komiya.
* PR265: Fix could not capture caption of graphviz node by xref. Thanks to
Takeshi Komiya.
* PR263, 1013, 1103: Rewrite of C++ domain. Thanks to Jakob Lykke Andersen.

* Hyperlinks to all found nested names and template arguments (1103).
* Support for function types everywhere, e.g., in
std::function<bool(int, int)> (1013).
* Support for virtual functions.
* Changed interpretation of function arguments to following standard
prototype declarations, i.e., void f(arg) means that arg is the type of the
argument, instead of it being the name.
* Updated tests.
* Updated documentation with elaborate description of what declarations are
supported and how the namespace declarations influence declaration and
cross-reference lookup.
* Index names may be different now. Elements are indexed by their fully
qualified name. It should be rather easy to change this behaviour and
potentially index by namespaces/classes as well.

* PR258, 939: Add dedent option for ``code-block`` and
``literalinclude``. Thanks to Zafar Siddiqui.
* PR268: Fix numbering section does not work at singlehtml mode. It still
ad-hoc fix because there is a issue that section IDs are conflicted.
Thanks to Takeshi Komiya.
* PR273, 1536: Fix RuntimeError with numbered circular toctree. Thanks to
Takeshi Komiya.
* PR274: Set its URL as a default title value if URL appears in toctree.
Thanks to Takeshi Komiya.
* PR276, 1381: ``rfc`` and ``pep`` roles support custom link
text. Thanks to Takeshi Komiya.
* PR277, 1513: highlights for function pointers in argument list of
``c:function``. Thanks to Takeshi Komiya.
* PR278: Fix section entries were shown twice if toctree has been put under
only directive. Thanks to Takeshi Komiya.
* 1547: pgen2 tokenizer doesn't recognize ``...`` literal (Ellipsis for py3).
* PR294: On LaTeX builder, wrap float environment on writing literal_block
to avoid separation of caption and body. Thanks to Takeshi Komiya.
* PR295, 1520: ``make.bat latexpdf`` mechanism to ``cd`` back to the current
directory. Thanks to Peter Suter.
* PR297, 1571: Add imgpath property to all builders. It make easier to
develop builder extensions. Thanks to Takeshi Komiya.
* 1584: Point to master doc in HTML "top" link.
* 1585: Autosummary of modules broken in Sphinx 1.2.3.
* 1610: Sphinx cause AttributeError when MeCab search option is enabled and
python-mecab is not installed.
* 1674: Do not crash if a module's ``__all__`` is not a list of strings.
* 1673: Fix crashes with :confval:`nitpick_ignore` and ``:doc:`` references.
* 1686: ifconfig directive doesn't care about default config values.
* 1642: Fix only one search result appearing in Chrome.

Documentation
-------------

* Add clarification about the syntax of tags. (:file:`doc/markup/misc.rst`)

1.2.3

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

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

* 1518: ``sphinx-apidoc`` command now has a ``--version`` option to show
version information and exit
* New locales: Hebrew, European Portuguese, Vietnamese.

Bugs fixed
----------

* 636: Keep straight single quotes in literal blocks in the LaTeX build.
* 1419: Generated i18n sphinx.js files are missing message catalog entries
from '.js_t' and '.html'. The issue was introduced from Sphinx 1.1
* 1363: Fix i18n: missing python domain's cross-references with currentmodule
directive or currentclass directive.
* 1444: autosummary does not create the description from attributes docstring.
* 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.
* 1467: Exception on Python3 if nonexistent method is specified by automethod
* 1441: autosummary can't handle nested classes correctly.
* 1499: With non-callable ``setup`` in a conf.py, now sphinx-build emits
a user-friendly error message.
* 1502: In autodoc, fix display of parameter defaults containing backslashes.
* 1226: autodoc, autosummary: importing setup.py by automodule will invoke
setup process and execute ``sys.exit()``. Now Sphinx avoids SystemExit
exception and emits warnings without unexpected termination.
* 1503: py:function directive generate incorrectly signature when specifying
a default parameter with an empty list ``[]``. Thanks to Geert Jansen.
* 1508: Non-ASCII filename raise exception on make singlehtml, latex, man,
texinfo and changes.
* 1531: On Python3 environment, docutils.conf with 'source_link=true' in the
general section cause type error.
* PR270, 1533: Non-ASCII docstring cause UnicodeDecodeError when uses with
inheritance-diagram directive. Thanks to WAKAYAMA shirou.
* PR281, PR282, 1509: TODO extension not compatible with websupport. Thanks
to Takeshi Komiya.
* 1477: gettext does not extract nodes.line in a table or list.
* 1544: ``make text`` generates wrong table when it has empty table cells.
* 1522: Footnotes from table get displayed twice in LaTeX. This problem has
been appeared from Sphinx 1.2.1 by 949.
* 508: Sphinx every time exit with zero when is invoked from setup.py command.
ex. ``python setup.py build_sphinx -b doctest`` return zero even if doctest
failed.

1.2.2

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

Bugs fixed
----------

* PR211: When checking for existence of the ``html_logo`` file, check
the full relative path and not the basename.
* PR212: Fix traceback with autodoc and ``__init__`` methods without docstring.
* PR213: Fix a missing import in the setup command.
* 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.
* 1358: Fix handling of image paths outside of the source directory when using
the "wildcard" style reference.
* 1374: Fix for autosummary generating overly-long summaries if first line
doesn't end with a period.
* 1383: Fix Python 2.5 compatibility of sphinx-apidoc.
* 1391: Actually prevent using "pngmath" and "mathjax" extensions at the same
time in sphinx-quickstart.
* 1386: Fix bug preventing more than one theme being added by the entry point
mechanism.
* 1370: Ignore "toctree" nodes in text writer, instead of raising.
* 1364: Fix 'make gettext' fails when the '.. todolist::' directive is present.
* 1367: Fix a change of PR96 that break sphinx.util.docfields.Field.make_field
interface/behavior for ``item`` argument usage.

Documentation
-------------

* Extended the :ref:`documentation about building extensions <dev-extensions>`.

1.2.1

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

Bugs fixed
----------

* 1335: Fix autosummary template overloading with exclamation prefix like
``{% extends "!autosummary/class.rst" %}`` cause infinite recursive function
call. This was caused by PR181.
* 1337: Fix autodoc with ``autoclass_content="both"`` uses useless
``object.__init__`` docstring when class does not have ``__init__``.
This was caused by a change for 1138.
* 1340: Can't search alphabetical words on the HTML quick search generated
with language='ja'.
* 1319: Do not crash if the ``html_logo`` file does not exist.
* 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).
* 751: Allow production lists longer than a page in LaTeX by using longtable.
* 764: Always look for stopwords lowercased in JS search.
* 814: autodoc: Guard against strange type objects that don't have
``__bases__``.
* 932: autodoc: Do not crash if ``__doc__`` is not a string.
* 933: Do not crash if an :rst:role:`option` value is malformed (contains
spaces but no option name).
* 908: On Python 3, handle error messages from LaTeX correctly in the pngmath
extension.
* 943: In autosummary, recognize "first sentences" to pull from the docstring
if they contain uppercase letters.
* 923: Take the entire LaTeX document into account when caching
pngmath-generated images. This rebuilds them correctly when
``pngmath_latex_preamble`` changes.
* 901: Emit a warning when using Docutils' new "math" markup without a Sphinx
math extension active.
* 845: In code blocks, when the selected lexer fails, display line numbers
nevertheless if configured.
* 929: Support parsed-literal blocks in LaTeX output correctly.
* 949: Update the tabulary.sty packed with Sphinx.
* 1050: Add anonymous labels into ``objects.inv`` to be referenced via
:mod:`~sphinx.ext.intersphinx`.
* 1095: Fix print-media stylesheet being included always in the "scrolls"
theme.
* 1085: Fix current classname not getting set if class description has
``:noindex:`` set.
* 1181: Report option errors in autodoc directives more gracefully.
* 1155: Fix autodocumenting C-defined methods as attributes in Python 3.
* 1233: Allow finding both Python classes and exceptions with the "class" and
"exc" roles in intersphinx.
* 1198: Allow "image" for the "figwidth" option of the :dudir:`figure`
directive as documented by docutils.
* 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.
* 1017: Be helpful and tell the user when the argument to :rst:dir:`option`
does not match the required format.
* 1345: Fix two bugs with ``nitpick_ignore``; now you don't have to
remove the store environment for changes to have effect.
* 1072: In the JS search, fix issues searching for upper-cased words by
lowercasing words before stemming.
* 1299: Make behavior of the :rst:dir:`math` directive more consistent and
avoid producing empty environments in LaTeX output.
* 1308: Strip HTML tags from the content of "raw" nodes before feeding it
to the search indexer.
* 1249: Fix duplicate LaTeX page numbering for manual documents.
* 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.
* 1285: Avoid name clashes between C domain objects and section titles.
* 848: Always take the newest code in incremental rebuilds with the
:mod:`sphinx.ext.viewcode` extension.
* 979, 1266: Fix exclude handling in ``sphinx-apidoc``.
* 1302: Fix regression in :mod:`sphinx.ext.inheritance_diagram` when
documenting classes that can't be pickled.
* 1316: Remove hard-coded ``font-face`` resources from epub theme.
* 1329: Fix traceback with empty translation msgstr in .po files.
* 1300: Fix references not working in translated documents in some instances.
* 1283: Fix a bug in the detection of changed files that would try to access
doctrees of deleted documents.
* 1330: Fix ``exclude_patterns`` behavior with subdirectories in the
``html_static_path``.
* 1323: Fix emitting empty ``<ul>`` tags in the HTML writer, which is not
valid HTML.
* 1147: Don't emit a sidebar search box in the "singlehtml" builder.

Documentation
-------------

* 1325: Added a "Intersphinx" tutorial section. (:file:`doc/tutorial.rst`)

Page 27 of 33

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.