![[BACK]](/icons/back.gif){kind=icon}
Up to [cvs.NetBSD.org] / pkgsrc / textproc / py-sphinx
Request diff between arbitrary revisions
Default branch: MAIN
Revision 1.95 / (download) - annotate - [select for diffs], Tue Nov 7 22:38:05 2023 UTC (5 months, 1 week ago) by wiz
Branch: MAIN
CVS Tags: pkgsrc-2024Q1-base,
pkgsrc-2024Q1,
pkgsrc-2023Q4-base,
pkgsrc-2023Q4,
HEAD
Changes since 1.94: +2 -2
lines
Diff to previous 1.94 (colored) to selected 1.73 (colored)
*: latest py-sphinx only support Python 3.9+
Revision 1.94 / (download) - annotate - [select for diffs], Tue Nov 7 22:27:09 2023 UTC (5 months, 1 week ago) by wiz
Branch: MAIN
Changes since 1.93: +4 -9
lines
Diff to previous 1.93 (colored) to selected 1.73 (colored)
py-sphinx: update to 7.2.6.
Release 7.2.6 (released Sep 13, 2023)
=====================================
Bugs fixed
----------
* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES` environment variable,
which if set reloads modules when using autodoc with ``TYPE_CHECKING = True``.
Patch by Matt Wozniski and Adam Turner.
* #11679: Use :py:func:`importlib.reload` to reload modules in autodoc.
Patch by Matt Wozniski and Adam Turner.
Release 7.2.5 (released Aug 30, 2023)
=====================================
Bugs fixed
----------
* #11645: Fix a regression preventing autodoc from importing modules within
packages that make use of ``if typing.TYPE_CHECKING:`` to guard circular
imports needed by type checkers.
Patch by Matt Wozniski.
* #11634: Fixed inheritance diagram relative link resolution
for sibling files in a subdirectory.
Patch by Albert Shih.
* #11659: Allow ``?config=...`` in :confval:`mathjax_path`.
* #11654: autodoc: Fail with a more descriptive error message
when an object claims to be an instance of ``type``,
but is not a class.
Patch by James Braza.
* 11620: Cease emitting :event:`source-read` events for files read via
the :dudir:`include` directive.
* 11620: Add a new :event:`include-read` for observing and transforming
the content of included files via the :dudir:`include` directive.
* #11627: Restore support for copyright lines of the form ``YYYY``
when ``SOURCE_DATE_EPOCH`` is set.
Release 7.2.4 (released Aug 28, 2023)
=====================================
Bugs fixed
----------
* #11618: Fix a regression in the MoveModuleTargets transform,
introduced in #10478 (#9662).
* #11649: linkcheck: Resolve hanging tests for timezones west of London
and incorrect conversion from UTC to offsets from the UNIX epoch.
Patch by Dmitry Shachnev and Adam Turner.
Release 7.2.3 (released Aug 23, 2023)
=====================================
Dependencies
------------
* #11576: Require sphinxcontrib-serializinghtml 1.1.9.
Bugs fixed
----------
* Fix regression in ``autodoc.Documenter.parse_name()``.
* Fix regression in JSON serialisation.
* #11543: autodoc: Support positional-only parameters in ``classmethod`` methods
when ``autodoc_preserve_defaults`` is ``True``.
* Restore support string methods on path objects.
This is deprecated and will be removed in Sphinx 8.
Use :py:func:`os.fspath` to convert :py:class:`~pathlib.Path` objects to strings,
or :py:class:`~pathlib.Path`'s methods to work with path objects.
Release 7.2.2 (released Aug 17, 2023)
=====================================
Bugs fixed
----------
* Fix the signature of the ``StateMachine.insert_input()`` patch,
for when calling with keyword arguments.
* Fixed membership testing (``in``) for the :py:class:`str` interface
of the asset classes (``_CascadingStyleSheet`` and ``_JavaScript``),
which several extensions relied upon.
* Fixed a type error in ``SingleFileHTMLBuilder._get_local_toctree``,
``includehidden`` may be passed as a string or a boolean.
* Fix ``:noindex:`` for ``PyModule`` and ``JSModule``.
Release 7.2.1 (released Aug 17, 2023)
=====================================
Bugs fixed
----------
* Restored the the :py:class:`str` interface of the asset classes
(``_CascadingStyleSheet`` and ``_JavaScript``), which several extensions relied upon.
This will be removed in Sphinx 9.
* Restored calls to ``Builder.add_{css,js}_file()``,
which several extensions relied upon.
* Restored the private API ``TocTree.get_toctree_ancestors()``,
which several extensions relied upon.
Release 7.2.0 (released Aug 17, 2023)
=====================================
Dependencies
------------
* #11511: Drop Python 3.8 support.
* #11576: Require Pygments 2.14 or later.
Deprecated
----------
* #11512: Deprecate ``sphinx.util.md5`` and ``sphinx.util.sha1``.
Use ``hashlib`` instead.
* #11526: Deprecate ``sphinx.testing.path``.
Use ``os.path`` or ``pathlib`` instead.
* #11528: Deprecate ``sphinx.util.split_index_msg`` and ``sphinx.util.split_into``.
Use ``sphinx.util.index_entries.split_index_msg`` instead.
* Deprecate ``sphinx.builders.html.Stylesheet``
and ``sphinx.builders.html.Javascript``.
Use ``sphinx.application.Sphinx.add_css_file()``
and ``sphinx.application.Sphinx.add_js_file()`` instead.
* #11582: Deprecate ``sphinx.builders.html.StandaloneHTMLBuilder.css_files`` and
``sphinx.builders.html.StandaloneHTMLBuilder.script_files``.
Use ``sphinx.application.Sphinx.add_css_file()``
and ``sphinx.application.Sphinx.add_js_file()`` instead.
* #11459: Deprecate ``sphinx.ext.autodoc.preserve_defaults.get_function_def()``.
Patch by Bénédikt Tran.
Features added
--------------
* #11526: Support ``os.PathLike`` types and ``pathlib.Path`` objects
in many more places.
* #5474: coverage: Print summary statistics tables.
Patch by Jorge Leitao.
* #6319: viewcode: Add :confval:`viewcode_line_numbers` to control
whether line numbers are added to rendered source code.
Patch by Ben Krikler.
* #9662: Add the ``:no-typesetting:`` option to suppress textual output
and only create a linkable anchor.
Patch by Latosha Maltba.
* #11221: C++: Support domain objects in the table of contents.
Patch by Rouslan Korneychuk.
* #10938: doctest: Add :confval:`doctest_show_successes` option.
Patch by Trey Hunner.
* #11533: Add ``:no-index:``, ``:no-index-entry:``, and ``:no-contents-entry:``.
* #11572: Improve ``debug`` logging of reasons why files are detected as out of
date.
Patch by Eric Larson.
* #10678: Emit :event:`source-read` events for files read via
the :dudir:`include` directive.
Patch by Halldor Fannar.
* #11570: Use short names when using :pep:`585` built-in generics.
Patch by Riccardo Mori.
* #11300: Improve ``SigElementFallbackTransform`` fallback logic and signature
text elements nodes. See :doc:`the documentation </extdev/nodes>` for more
details.
Patch by Bénédikt Tran.
* Allow running Sphinx with ``python -m sphinx build ...``.
Bugs fixed
----------
* #11077: graphviz: Fix relative links from within the graph.
Patch by Ralf Grubenmann.
* #11529: Line Block in LaTeX builder outputs spurious empty token.
Patch by Adrian Vollmer.
* #11196: autosummary: Summary line extraction failed with "e.g."
* #10614: Fixed a number of bugs in inheritance diagrams that resulted in
missing or broken links.
Patch by Albert Shih.
* #9428: Exclude substitution definitions when running the ``gettext`` builder.
Patch by Alvin Wong.
* #10795: Raise a descriptive error if ``graphviz_dot`` is falsy.
* #11546: Translated nodes identical to their original text are now marked
with the ``translated=True`` attribute.
* #10049: html: Change "Permalink" to "Link" for title text in link anchors.
* #4225: Relax Pygments parsing on lexing failures.
* #11246: Allow inline links in the first line of a docstring and one-line
type comments ``#: :meta ...:`` when using :mod:`sphinx.ext.napoleon`.
Patch by Bénédikt Tran.
* #10930: Highlight all search terms on the search results page.
Patch by Dmitry Shachnev.
* #11473: Type annotations containing :py:data:`~typing.Literal` enumeration
values now render correctly.
Patch by Bénédikt Tran.
* #11591: Fix support for C coverage in ``sphinx.ext.coverage`` extension.
Patch by Stephen Finucane.
* #11594: HTML Theme: Enhancements to horizontal scrolling on smaller
devices in the ``agogo`` theme.
Patch by Lukas Engelter.
* #11459: Fix support for async and lambda functions in
``sphinx.ext.autodoc.preserve_defaults``.
Patch by Bénédikt Tran.
Testing
-------
* #11577: pytest: Fail tests on "XPASS".
* #11577: pytest: Use "importlib" import mode.
* #11577: pytest: Set PYTHONWARNINGS=error.
* #11577: pytest: Set strict config and strict markers.
Revision 1.93 / (download) - annotate - [select for diffs], Sat Oct 28 19:57:19 2023 UTC (5 months, 2 weeks ago) by wiz
Branch: MAIN
Changes since 1.92: +2 -1
lines
Diff to previous 1.92 (colored) to selected 1.73 (colored)
python/wheel.mk: simplify a lot, and switch to 'installer' for installation This follows the recommended bootstrap method (flit_core, build, installer). However, installer installs different files than pip, so update PLISTs for all packages using wheel.mk and bump their PKGREVISIONs.
Revision 1.92 / (download) - annotate - [select for diffs], Wed Aug 2 07:16:15 2023 UTC (8 months, 2 weeks ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2023Q3-base,
pkgsrc-2023Q3
Changes since 1.91: +3 -7
lines
Diff to previous 1.91 (colored) to selected 1.73 (colored)
py-sphinx: updated to 7.1.2
Release 7.1.2 (released Aug 02, 2023)
=====================================
Bugs fixed
----------
* linkcheck: Properly respect :confval:`linkcheck_anchors`
and do not spuriously report failures to validate anchors.
Patch by James Addison.
Release 7.1.1 (released Jul 27, 2023)
=====================================
Bugs fixed
----------
* Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer.
Patch by Bénédikt Tran.
Release 7.1.0 (released Jul 24, 2023)
=====================================
Incompatible changes
--------------------
* Releases are no longer signed, given the `change in PyPI policy`_.
.. _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
----------
* Emit warnings on using a deprecated Python-specific index entry type
(namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``,
``statement``, and ``builtin``) in the :rst:dir:`index` directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.
Features added
--------------
* Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.
* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
requirement to be specified as ``(major, minor)``.
* Allow configuring a line-length limit for object signatures, via
:confval:`maximum_signature_line_length` and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
Patch by Thomas Louf, Adam Turner, and Jean-François B.
* Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin
* ``sphinx.util.display.status_iterator`` now clears the current line
with ANSI control codes, rather than overprinting with space characters.
* linkcheck: Treat SSL failures as broken links.
Patch by James Addison.
* Keep the ``translated`` attribute on translated nodes.
* Improve the traceback displayed when using :option:`sphinx-build -T`
in parallel builds. Patch by Bénédikt Tran
* linkcheck: Use session-basd HTTP requests.
* Add support for the :rst:dir:`py:class` and :rst:dir:`py:function`
directives for PEP 695 (generic classes and functions declarations) and
PEP 696 (default type parameters). Multi-line support is enabled
for type parameters list and can be locally controlled on object description
directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`.
Patch by Bénédikt Tran.
* linkcheck: Allow HTML anchors to be ignored on a per-URL basis
via :confval:`linkcheck_anchors_ignore_for_url` while
still checking the validity of the page itself.
Patch by Bénédikt Tran
* Add translation progress statistics and inspection support,
via a new substitution (``|translation progress|``) and a new
configuration variable (:confval:`translation_progress_classes`).
These enable determining the percentage of translated elements within
a document, and the remaining translated and untranslated elements.
Bugs fixed
----------
* Restored the ``footnote-reference`` class that has been removed in
the latest (unreleased) version of Docutils.
* Use :rfc:`8081` font file MIME types in the EPUB builder.
Using the correct MIME type will prevent warnings from ``epubcheck``
and will generate a valid EPUB.
* Use microsecond-resolution timestamps for outdated file detection
in ``BuildEnvironment.get_outdated_files``.
* Top-level headings starting with a reStructuredText role
now render properly when :confval:`rst_prolog` is set.
Previously, a file starting with the below would have
improperly rendered due to where the prologue text
was inserted into the document.
.. code:: rst
:mod:`lobster` -- The lobster module
====================================
...
Patch by Bénédikt Tran.
* Fix a ``MemoryError`` in ``sphinx.ext.intersphinx`` when using ``None``
or ``typing.*`` as inline type references. Patch by Bénédikt Tran (picnixz)
Testing
-------
* Always delete ``docutils.conf`` in test directories when running
``SphinxTestApp.cleanup()``.
Revision 1.91 / (download) - annotate - [select for diffs], Tue Aug 1 23:20:54 2023 UTC (8 months, 2 weeks ago) by wiz
Branch: MAIN
Changes since 1.90: +2 -2
lines
Diff to previous 1.90 (colored) to selected 1.73 (colored)
*: remove more references to Python 3.7
Revision 1.90 / (download) - annotate - [select for diffs], Mon May 15 21:01:45 2023 UTC (11 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2023Q2-base,
pkgsrc-2023Q2
Changes since 1.89: +2 -2
lines
Diff to previous 1.89 (colored) to selected 1.73 (colored)
py-sphinx: updated to 7.0.1 7.0.1 Dependencies * Support `Docutils 0.20`_. Patch by Adam Turner. Bugs fixed * Clean up remaining references to ``sphinx.setup_command`` following the removal of support for setuptools. Patch by Willem Mulder.
Revision 1.89 / (download) - annotate - [select for diffs], Thu May 4 09:42:10 2023 UTC (11 months, 2 weeks ago) by adam
Branch: MAIN
Changes since 1.88: +8 -7
lines
Diff to previous 1.88 (colored) to selected 1.73 (colored)
py-sphinx: updated to 7.0.0 Release 7.0.0 (released Apr 29, 2023) Incompatible changes * Remove long-deprecated aliases for MecabSplitter and DefaultSplitter in sphinx.search.ja. * Remove deprecated make_old_id functions in domain object description classes. * Remove the Setuptools integration (build_sphinx hook in setup.py). * Remove deprecated sphinx.ext.napoleon.iterators module. * Remove support for the jsdump format in sphinx.search. * Make locale a required argument to sphinx.util.i18n.format_date(). * Remove deprecated sphinx.util.stemmer module. * Remove deprecated sphinx.pycode.ast.parse() function. * Remove deprecated sphinx.io.read_doc() function. * Removed deprecated sphinx.util.get_matching_files() function. * Remove deprecated sphinx.util.docutils.is_html5_writer_available() function. * Make the env argument to Builder subclasses required. * autosummary: Always emit grouped import exceptions. * Remove deprecated style key for HTML templates. * Remove deprecated sphinx.writers.latex.LaTeXTranslator.docclasses attribute. * Remove deprecated sphinx.builders.html.html5_ready and sphinx.builders.html.HTMLTranslator attributes. * Remove support for HTML 4 output.
Revision 1.88 / (download) - annotate - [select for diffs], Wed Mar 29 09:34:14 2023 UTC (12 months, 3 weeks ago) by wiz
Branch: MAIN
Changes since 1.87: +3 -2
lines
Diff to previous 1.87 (colored) to selected 1.73 (colored)
*: use PYTHON_VERSION instead of _PYTHON_VERSION
Revision 1.87 / (download) - annotate - [select for diffs], Tue Oct 25 18:36:42 2022 UTC (17 months, 3 weeks ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2023Q1-base,
pkgsrc-2023Q1,
pkgsrc-2022Q4-base,
pkgsrc-2022Q4
Changes since 1.86: +16 -15
lines
Diff to previous 1.86 (colored) to selected 1.73 (colored)
py-sphinx: updated to 5.3.0 Release 5.3.0 (released Oct 16, 2022) ===================================== Features added -------------- * LaTeX: add :confval:`latex_table_style` and support the ``'booktabs'``, ``'borderless'``, and ``'colorrows'`` styles. * One can cross-reference including an option value like ``:option:`--module=foobar```, ``:option:`--module[=foobar]``` or ``:option:`--module foobar```. Patch by Martin Liska. * autosectionlabel: Record the generated section label to the debug log. * Correctly URI-escape image filenames. * domains: Allow sections in all the content of all object description directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner Release 5.2.3 (released Sep 30, 2022) ===================================== * Fix base64 image embedding in ``sphinx.ext.imgmath`` * Add ``:nocontentsentry:`` flag and global domain table of contents entry control option. Patch by Adam Turner Release 5.2.2 (released Sep 27, 2022) ===================================== * Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster. Release 5.2.1 (released Sep 25, 2022) ===================================== Bugs fixed ---------- * Always normalise the ``pycon3`` lexer to ``pycon``. * Fix using ``sphinx.ext.autosummary`` with modules containing titles in the module-level docstring. Release 5.2.0.post0 (released Sep 24, 2022) =========================================== * Recreated source tarballs for Debian maintainers. Release 5.2.0 (released Sep 24, 2022) ===================================== Dependencies ------------ * Sphinx now uses declarative metadata with ``pyproject.toml`` to create packages, using PyPA's ``flit`` project as a build backend. Patch by Adam Turner. Deprecated ---------- * Support for HTML 4 output. Patch by Adam Turner. Features added -------------- * napoleon: Add support for docstring types using 'of', like ``type of type``. Example: ``tuple of int``. * C++, support requires clauses not just between the template parameter lists and the declaration. * linkcheck: Check the source URL of raw directives that use the ``url`` option. * Allow :rst:role:`ref` role to be used with definitions and fields. * HTML Search: Increase priority for full title and subtitle matches in search results * HTML Search: Save search result score to the HTML element for debugging * Make toctree accept 'genindex', 'modindex' and 'search' docnames * Add domain objects to the table of contents. Patch by Adam Turner * HTML Search: Include explicit :rst:dir:`index` directive index entries in the search index and search results. Patch by Adam Turner * imgmath: Allow embedding images in HTML as base64 * HTML Search: Use browser localstorage for highlight control, stop storing highlight parameters in URL query strings. Patch by Adam Turner. Bugs fixed ---------- * LaTeX: 5.1.0 has made the 'sphinxsetup' ``verbatimwithframe=false`` become without effect. * C++, ensure consistent non-specialization template argument representation. * C++, fix parsing of certain non-type template parameter packs. * Revert 10520: "Fix" use of sidebar classes in ``agogo.css_t`` Release 5.1.1 (released Jul 26, 2022) ===================================== Bugs fixed ---------- * Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean`` iterator implementation. * Restore compatability with third-party builders. Release 5.1.0 (released Jul 24, 2022) ===================================== Dependencies ------------ * Support `Docutils 0.19`_. Patch by Adam Turner. Deprecated ---------- * Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``. Patch by Adam Turner. * Deprecated ``sphinx.ext.napoleon.iterators``. Features added -------------- * html theme: Allow specifying multiple CSS files through the ``stylesheet`` setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings. * std domain: Add support for emphasising placeholders in :rst:dir:`option` directives through a new :confval:`option_emphasise_placeholders` configuration option. * std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify. * quickstart: Reduce content in the generated ``conf.py`` file. Patch by Pradyun Gedam. * LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' <latexsphinxsetup>` keys allow to configure four separate border-widths, four paddings, four corner radii, a shadow (possibly inset), colours for border, background, shadow for each of the code-block, topic, attention, caution, danger, error and warning directives. * LaTeX: Explain non-standard encoding in LatinRules.xdy * HTML Theme: Wrap consecutive footnotes in an ``<aside>`` element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner. * config: Add ``include_patterns`` as the opposite of ``exclude_patterns``. Patch by Adam Turner. Bugs fixed ---------- * HTML Theme: field term colons are doubled if using Docutils 0.18+ * Build failure if Docutils version is 0.18 (not 0.18.1) due to missing ``Node.findall()`` * LaTeX: build error if highlighting inline code role in figure caption * Make -P (pdb) option work better with exceptions triggered from events * py domain: Fix spurious whitespace in unparsing various operators (``+``, ``-``, ``~``, and ``**``). Patch by Adam Turner. * logging: Always show node source locations as absolute paths. * HTML Search: HTML tags are displayed as a part of object name * HTML Search: search snipets should not be folded * HTML Search: Minor errors are emitted on fetching search snipets * HTML Search: The markers for header links are shown in the search result * HTML Theme: Fix use of sidebar classes in ``agogo.css_t``. * HTML Theme: Fix inclusion of hidden toctrees in the agogo theme. * HTML Theme: Fix enable_search_shortcuts does not work * LaTeX: Text can fall out of code-block at end of page and leave artifact on next page * LaTeX: user injected ``\color`` commands in topic or admonition boxes may cause color leaks in PDF due to upstream `framed.sty <https://ctan.org/pkg/framed>`_ bug * LaTeX: framed coloured boxes in highlighted code (e.g. highlighted diffs using Pygments style ``'manni'``) inherit thickness of code-block frame * LaTeX: Only one ``\label`` is generated for ``desc_signature`` node even if it has multiple node IDs * i18n: UnboundLocalError is raised on translating raw directive * py domain: Fix warning for duplicate Python references when using ``:any:`` and autodoc. * HTML Search: fix minor summary issues.
Revision 1.86 / (download) - annotate - [select for diffs], Fri Apr 15 15:58:35 2022 UTC (2 years ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2022Q3-base,
pkgsrc-2022Q3,
pkgsrc-2022Q2-base,
pkgsrc-2022Q2
Changes since 1.85: +2 -3
lines
Diff to previous 1.85 (colored) to selected 1.73 (colored)
py-sphinx: updated to 4.5.0
Release 4.5.0 (released Mar 28, 2022)
=====================================
Incompatible changes
--------------------
* extlinks: Disable hardcoded links detector by default
* std domain: Disallow to refer an inline target via
:rst:role:`ref` role
Deprecated
----------
* ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``
Features added
--------------
* Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
* autosummary: Add "autosummary" CSS class to summary tables
* extlinks: Improve suggestion message for a reference having title
* extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable
hardcoded links detector feature
* html search: Add a config variable
:confval:`html_show_search_summary` to enable/disable the search summaries
* HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:'/' as
a Quick search shortcut and :kbd:`Esc` shortcut that
removes search highlighting.
* i18n: Allow to suppress translation warnings by adding ``#noqa``
comment to the tail of each translation message
* C++, support attributes on classes, unions, and enums.
* :rst:dir:`pep` role now generates URLs based on peps.python.org
Bugs fixed
----------
* autodoc: Failed to document an imported class that is built from native
binary module
* autodoc: Crashed when mocked module is used for type annotation
* autodoc: :confval:`autodoc_default_options` does not support
``no-value`` option
* autodoc: TypeError is raised when the target object is annotated by
unhashable object
* extlinks: Failed to compile regexp on checking hardcoded links
* html search: Could not search short words (ex. "use")
* LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred
multiple times was rendered to a question mark
* LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical
spacing in Latexpdf
* LaTeX: excessive whitespace since v4.4.0 for undocumented
variables/structure members
* LaTeX: named footnote reference is linked to an incorrect footnote if
the name is also used in the different document
* manpage: Failed to resolve the title of :ref: cross references
* i18n: suppress "rST localization" warning
* imgconverter: Unnecessary availablity check is called for remote URIs
* napoleon: attributes are displayed like class attributes for google
style docstrings when :confval:`napoleon_use_ivar` is enabled
* sphinx-build: make.bat does not check the installation of sphinx-build
command before showing help
Revision 1.85 / (download) - annotate - [select for diffs], Tue Jan 25 09:20:30 2022 UTC (2 years, 2 months ago) by wiz
Branch: MAIN
CVS Tags: pkgsrc-2022Q1-base,
pkgsrc-2022Q1
Changes since 1.84: +3 -2
lines
Diff to previous 1.84 (colored) to selected 1.73 (colored)
py-sphinx: restore lower bound now that package is updated Bump PKGREVISION since it didn't actually run with older versions.
Revision 1.84 / (download) - annotate - [select for diffs], Tue Jan 25 00:26:18 2022 UTC (2 years, 2 months ago) by wiz
Branch: MAIN
Changes since 1.83: +2 -2
lines
Diff to previous 1.83 (colored) to selected 1.73 (colored)
py-sphinx: remove lower bound on py-importlib-metadata pkgsrc version is not new enough; hopefully someone will update it soon
Revision 1.83 / (download) - annotate - [select for diffs], Mon Jan 24 18:21:18 2022 UTC (2 years, 2 months ago) by adam
Branch: MAIN
Changes since 1.82: +9 -6
lines
Diff to previous 1.82 (colored) to selected 1.73 (colored)
py-sphinx: updated to 4.4.0 Release 4.4.0 (released Jan 17, 2022) ===================================== Dependencies ------------ * Use ``importlib_metadata`` for python-3.9 or older * Drop ``setuptools`` Features added -------------- * autodoc: Add a config variable :confval:`autodoc_typehints_format` to suppress the leading module names of typehints of function signatures (ex. ``io.StringIO`` -> ``StringIO``) * Autosummary now documents only the members specified in a module's ``__all__`` attribute if :confval:`autosummary_ignore_module_all` is set to ``False``. The default behaviour is unchanged. Autogen also now supports this behavior with the ``--respect-module-all`` switch. * autosummary: Improve error messages on failure to load target object * extlinks: Emit warning if a hardcoded link is replaceable by an extlink, suggesting a replacement. * html: Support nested <kbd> HTML elements in other HTML builders * html: Allow to change the loading method of JS via ``loading_method`` parameter for :meth:`Sphinx.add_js_file()` * html search: "Hide Search Matches" link removes "highlight" parameter from URL * html theme: Wrap sidebar components in div to allow customizing their layout via CSS * i18n: Sort items in glossary by translated terms * py domain: Allows to specify cross-reference specifier (``.`` and ``~``) as ``:type:`` option * linkcheck: add option ``linkcheck_exclude_documents`` to disable link checking in matched documents. * sphinx-build: Allow to use the parallel build feature in macOS on macOS and Python3.8+ * sphinx-build: Create directories when ``-w`` option given * std domain: Allow to refer an inline target (ex. ``_`target name```) via :rst:role:`ref` role * std domain: Strip value part of the option directive from general index * texinfo: improve variable in ``samp`` role * texinfo: Add :confval:`texinfo_cross_references` to disable cross references for readability with standalone readers * add new Intersphinx role :rst:role:`external` for explict lookup in the external projects, without resolving to the local project. Bugs fixed ---------- * autodoc: doccomment for the imported class was ignored * autodoc: doccomment for the alias to mocked object was ignored * autodoc: debug message is shown on building document using NewTypes with Python 3.10 * autodoc: instance variables are not shown if __init__ method has position-only-arguments * autodoc: types under the "typing" module are not hyperlinked * autodoc: Crashes if target object raises an error on getting docstring * autosummary: Imported members are not shown when ``autodoc_class_signature = 'separated'`` * i18n: topic directive having a bullet list can't be translatable * mathjax: MathJax configuration is placed after loading MathJax itself * napoleon: empty "returns" section is generated even if no description * Generated RFC links use outdated base url * HTML, prevent line-wrapping in literal text. * html theme: Configuration values added by themes are not be able to override from conf.py * imgconverter: Unnecessary availablity check is called for "data" URIs * LaTeX: prohibit also with ``'xelatex'`` line splitting at dashes of inline and parsed literals * LaTeX: extra vertical whitespace for some nested declarations * LaTeX: Multi-function declaration in Python domain has cramped vertical spacing in latexpdf output * py domain: types under the "typing" module are not hyperlinked defined at info-field-list * texinfo: Do not emit labels inside footnotes * xml: Invalid XML was generated when cross referencing python objects * Error level messages were displayed as warning messages * Failed to scan documents if the project is placed onto the root directory * code-block: ``:dedent:`` without argument did strip newlines
Revision 1.82 / (download) - annotate - [select for diffs], Wed Jan 5 15:41:26 2022 UTC (2 years, 3 months ago) by wiz
Branch: MAIN
Changes since 1.81: +4 -2
lines
Diff to previous 1.81 (colored) to selected 1.73 (colored)
python: egg.mk: add USE_PKG_RESOURCES flag This flag should be set for packages that import pkg_resources and thus need setuptools after the build step. Set this flag for packages that need it and bump PKGREVISION.
Revision 1.81 / (download) - annotate - [select for diffs], Tue Jan 4 20:55:05 2022 UTC (2 years, 3 months ago) by wiz
Branch: MAIN
Changes since 1.80: +2 -1
lines
Diff to previous 1.80 (colored) to selected 1.73 (colored)
*: bump PKGREVISION for egg.mk users They now have a tool dependency on py-setuptools instead of a DEPENDS
Revision 1.80 / (download) - annotate - [select for diffs], Sun Dec 19 16:49:41 2021 UTC (2 years, 3 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2021Q4-base,
pkgsrc-2021Q4
Changes since 1.79: +2 -2
lines
Diff to previous 1.79 (colored) to selected 1.73 (colored)
py-sphinx: updated to 4.3.2 Release 4.3.2 (released Dec 19, 2021) ===================================== Bugs fixed ---------- * C and C++, parse fundamental types no matter the order of simple type specifiers.
Revision 1.79 / (download) - annotate - [select for diffs], Sun Nov 28 16:34:49 2021 UTC (2 years, 4 months ago) by adam
Branch: MAIN
Changes since 1.78: +2 -2
lines
Diff to previous 1.78 (colored) to selected 1.73 (colored)
py-sphinx: updated to 4.3.1 Release 4.3.1 (released Nov 28, 2021) Features added * mathjax: Support chnaging the loading method of MathJax to ×Åeferãàvia mathjax_options Bugs fixed * autodoc: AttributeError is raised on building document for functions decorated by functools.lru_cache * autodoc: AttributeError is raised on building document for an object having invalid __doc__ atribute * autodoc: Failed to process a function wrapped with functools.partial if autodoc_preserve_defaults enabled * html: Class namespace collision between autodoc signatures and docutils-0.17 * imgmath: Crashed if the dvisvgm command failed to convert equation * mathjax: Failed to render equations via MathJax v2. The loading method of MathJax is back to ãà×Âsyncãàmethod again
Revision 1.78 / (download) - annotate - [select for diffs], Thu Nov 11 08:59:09 2021 UTC (2 years, 5 months ago) by adam
Branch: MAIN
Changes since 1.77: +4 -4
lines
Diff to previous 1.77 (colored) to selected 1.73 (colored)
py-sphinx: updated to 4.3.0 Release 4.3.0 Dependencies Support Python 3.10 Incompatible changes * searchindex.js: the embedded data has changed format to allow objects with the same name in different domains. * The rendering of Python domain declarations is implemented with more docutils nodes to allow better CSS styling. It may break existing styling. * the signature of domains.py.PyObject.get_signature_prefix() has changed to return a list of nodes instead of a plain string. * domains.js.JSObject.display_prefix has been changed into a method get_display_prefix which now returns a list of nodes instead of a plain string. * The rendering of Javascript domain declarations is implemented with more docutils nodes to allow better CSS styling. It may break existing styling. * mathjax: Load MathJax via ãà×Åeferãàstrategy Deprecated sphinx.ext.autodoc.AttributeDocumenter._datadescriptor sphinx.writers.html.HTMLTranslator._fieldlist_row_index sphinx.writers.html.HTMLTranslator._table_row_index sphinx.writers.html5.HTML5Translator._fieldlist_row_index sphinx.writers.html5.HTML5Translator._table_row_index Features added * autodoc: Support asynchronous generator functions * autodoc: autodoc-process-bases supports to inject reST snippet as a base class * C, added new info-field retval for c:function and c:macro. C++, added new info-field retval for cpp:function. * i18n: Add gettext_allow_fuzzy_translations to allow ãà×Çuzzyãàmessages for translation * More CSS classes on Python domain descriptions * More CSS classes on Javascript domain descriptions * Revert the removal of add_stylesheet() API. It will be kept until the Sphinx-6.0 release * add intersphinx_disabled_reftypes for disabling interphinx resolution of cross-references that do not have an explicit inventory specification. Specific types of cross-references can be disabled, e.g., std:doc or all cross-references in a specific domain, e.g., std:*. * Allow to suppress ãà×Õoctree contains reference to excluded documentãàwarnings using suppress_warnings Bugs fixed * autodoc: Failed to build cross references if primary_domain is not ãàÏÑyãà* autodoc: Crashed on getting source info from problematic object * autodoc: mocked object having doc comment is warned unexpectedly * autodoc: return type field is not generated even if autodoc_typehints_description_target is set to ãà×Åocumentedãàwhen its info-field-list contains :returns: field * autodoc: The base class for a subclass of mocked object is incorrect * autodoc: Incorrect base class detection for the subclasses of the generic class * autodoc: memory addresses are shown for aliases * autodoc: Failed to detect type annotation for slots attribute * autodoc: Crashed if classmethod does not have __func__ attribute * autodoc: autodoc_inherit_docstrings does not effect to overriden classmethods * autodoc: autodoc_preserve_defaults does not support hexadecimal numeric * autosummary: Failed to build summary table if primary_domain is not ãàÏÑyãà* html: Fix download file with special characters * html: Wrong styles for even/odd rows in nested tables * html: parameter name and its type annotation are not separated in HTML * HTML search: when objects have the same name but in different domains, return all of them as result instead of just one. * intersphinx: references on the file in sub directory are broken * LaTeX: hlist is rendered as a list containing ãà×Âggedrightãàtext * linkcheck: file extension was shown twice in warnings * py domain: An index entry with parens was registered for py:method directive with :property: option * py domain: Literal typehint was converted to a cross reference when autodoc_typehints='description' * needs_extension failed to check double-digit version correctly * Fix code` does not recognize :class: option * Fix for logging handler flushing warnings in the middle of the docs build * Fix warnings without subtype being incorrectly suppressed Intersphinx, for unresolved references with an explicit inventory, e.g., proj:myFunc, leave the inventory prefix in the unresolved text.
Revision 1.77 / (download) - annotate - [select for diffs], Fri Oct 29 16:16:41 2021 UTC (2 years, 5 months ago) by adam
Branch: MAIN
Changes since 1.76: +3 -3
lines
Diff to previous 1.76 (colored) to selected 1.73 (colored)
py-sphinx: updated to 4.2.0
Release 4.2.0 (released Sep 12, 2021)
=====================================
Features added
--------------
* autodoc: Support class properties
* autodoc: Emit a warning if target is a mocked object
* autodoc: Allow to refer NewType instances with module name in Python
3.10 or above
* html theme: Expose the version of Sphinx in the form of tuple as a
template variable ``sphinx_version_tuple``
* manpage: Suppress the title of man page if description is empty
* py domain: ``:py:property:`` directive supports ``:classmethod:``
option to describe the class property
* test: SphinxTestApp can take ``builddir`` as an argument
* C and C++, support more fundamental types, including GNU extensions.
Bugs fixed
----------
* apidoc: apidoc does not generate a module definition for implicit
namespace package
* autodoc: generate incorrect reference to the parent class if the target
class inherites the class having ``_name`` attribute
* autodoc: Some objects under ``typing`` module are not displayed
well with the HEAD of 3.10
* autodoc: typehint for cached_property is not shown
* autodoc: AttributeError is raised on failed resolving typehints
* autodoc: autodoc_docstring_signature does not effect to ``__init__()``
and ``__new__()``
* autodoc: PEP 585 style typehints having arguments (ex. ``list[int]``)
are not displayed well
* autosummary: some warnings contain non-existing filenames
* autosummary: summarise overlined sectioned headings correctly
* autosummary: Type annotations which contain commas in autosummary table
are not removed completely
* c domain: some warnings contain non-existing filenames
* cpp domain: some warnings contain non-existing filenames
* html search: abbreation marks are inserted to the search result if
failed to fetch the content of the page
* html search: The JS requirement warning is shown if browser is slow
* html theme: CSS and JS files added by theme were loaded twice
* py domain: ``:type:`` option for :rst:dir:`py:property` directive does
not create a hyperlink
* py domain: Literal typehint was converted to a cross reference
* comment: C++, fix parsing of defaulted function parameters that are
function pointers.
* smartquotes: don't adjust typography for text with
language-highlighted ``:code:`` role.
* sphinx-build: crashed with the HEAD of Python 3.10
Release 4.1.2 (released Jul 27, 2021)
=====================================
Incompatible changes
--------------------
* linkcheck: Disable checking automatically generated anchors on
github.com (ex. anchors in reST/Markdown documents)
Bugs fixed
----------
* autodoc: Custom types using ``typing.NewType`` are not displayed well
with the HEAD of 3.10
* autodoc: Some objects under ``typing`` module are not displayed well
with the HEAD of 3.10
* autodoc: crashed if ``autodoc_class_signature = "separated"``
* html search: html_copy_source can't control the search summaries
* linkcheck: Failed to check anchors in github.com
Release 4.1.1 (released Jul 15, 2021)
=====================================
Dependencies
------------
* sphinxcontrib-htmlhelp-2.0.0 or above
* sphinxcontrib-serializinghtml-1.1.5 or above
Bugs fixed
----------
* html: HTML logo or Favicon specified as file not being found on output
Release 4.1.0 (released Jul 12, 2021)
=====================================
Dependencies
------------
* Support jinja2-3.0
Deprecated
----------
* The ``app`` argument of ``sphinx.environment.BuildEnvironment`` becomes
required
* ``sphinx.application.Sphinx.html_theme``
* ``sphinx.ext.autosummary._app``
* ``sphinx.util.docstrings.extract_metadata()``
Features added
--------------
* autodoc: Add ``class-doc-from`` option to :rst:dir:`autoclass`
directive to control the content of the specific class like
:confval:`autoclass_content`
* autodoc: :confval:`autodoc_type_aliases` now supports dotted name. It
allows you to define an alias for a class with module name like
``foo.bar.BazClass``
* autodoc: Special member is not documented in the module
* autodoc: The arguments of ``typing.Literal`` are wrongly rendered
* autodoc: :confval:`autodoc_typehints` allows ``'both'`` setting to
allow typehints to be included both in the signature and description
* autodoc: Add :confval:`autodoc_class_signature` to separate the class
entry and the definition of ``__init__()`` method
* autodoc: Support variable comment for alias classes
* autodoc: Add :event:`autodoc-process-bases` to modify the base classes
of the class definitions
* autodoc: Render enum values for the default argument value better
* autodoc: ``autodoc_typehints='none'`` now erases typehints for
variables, attributes and properties
* autosummary: Support instance attributes for classes
* html: Add "heading" role to the toctree items
* html: Add span tag to the return typehint of method/function
* html search: Show search summaries when html_copy_source = False
* html search: Prevent corrections and completions in search field
* html theme: Eliminate prompt characters of code-block from copyable
text
* i18n: Emit a debug message if message catalog file not found under
:confval:`locale_dirs`
* LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents
* linkcheck: Support checking anchors on github.com
* linkcheck: Add a new event :event:`linkcheck-process-uri` to modify
URIs before checking hyperlinks
* linkcheck: Add :confval:`linkcheck_allowed_redirects` to mark
hyperlinks that are redirected to expected URLs as "working"
* py domain: Support union types using ``|`` in info-field-list
* py domain: :confval:`python_use_unqualified_type_names` supports type
field in info-field-list
* Optimize the parallel build
* Add :confval:`nitpick_ignore_regex` to ignore nitpicky warnings using
regular expressions
* Add ``Sphinx.set_html_assets_policy`` to tell extensions to include
HTML assets in all the pages. Extensions can check this via
``Sphinx.registry.html_assets_policy``
* C++, add support for
- ``inline`` variables,
- ``consteval`` functions,
- ``constinit`` variables,
- ``char8_t``,
- ``explicit(<constant expression>)`` specifier,
- digit separators in literals, and
- constraints in placeholder type specifiers, aka. adjective syntax
(e.g., ``Sortable auto &v``).
* C, add support for digit separators in literals.
* LaTeX: support containers in LaTeX output
Bugs fixed
----------
* autodoc: stacked singledispatches are wrongly rendered
* autodoc: a docsting having metadata only should be treated as
undocumented
* autodoc: typehints for overloaded functions and methods are inaccurate
* autodoc: The inherited method not having docstring is wrongly parsed
* autodoc: autoattribute directive failed to generate document for an
attribute not having any comment
* autodoc: single element tuple on the default argument value is wrongly
rendered
* autodoc: AttributeError is raised on processing a subclass of Tuple[()]
* autodoc: TypeError is raised on processing dict-like object (not a
class) via autoclass directive
* html: Pushing left key causes visiting the next page at the first page
* html: URL for html_favicon and html_log does not work
* html theme : pyramid theme generates incorrect logo links
* manpage: The name of manpage directory that is generated by
:confval:`man_make_section_directory` is not correct
* manpage: Fix font isn't reset after keyword at the top of samp role
* Linkcheck reports broken link when remote server closes the connection
on HEAD request
* py domain: "exceptions" module is not displayed
* py domain: a Callable annotation with no parameters
(e.g. ``Callable[[], None])`` will be rendered with a bracket missing
(``Callable[], None]``)
* quickstart: Make sphinx-quickstart exit when conf.py already exists
* xml: XML Builder ignores custom visitors
* ``:param:`` and ``:type:`` fields does not support a type containing
whitespace (ex. ``Dict[str, str]``)
* when transforming typed fields, call the specified role instead of
making an single xref. For C and C++, use the ``expr`` role for typed fields.
Release 4.0.3 (released Jul 05, 2021)
=====================================
Features added
--------------
* C, add C23 keywords ``_Decimal32``, ``_Decimal64``, and ``_Decimal128``.
* C, add :confval:`c_extra_keywords` to allow user-defined keywords
during parsing.
* Revert the removal of ``sphinx.util:force_decode()`` to become some 3rd party
extensions available again during 5.0
Bugs fixed
----------
* changeset domain: :rst:dir:`versionchanged` with contents being a list
will cause error during pdf build
* LaTeX: complex table with merged cells broken since 4.0
* LaTeX: backslash may cause Improper discretionary list pdf build error
with Japanese engines
* C, remove special macro names from the keyword list.
See also :confval:`c_extra_keywords`.
* KeyError is raised on PropagateDescDomain transform
Release 4.0.2 (released May 20, 2021)
=====================================
Dependencies
------------
* Support jinja2-3.0
Incompatible changes
--------------------
* Update Underscore.js to 1.13.1
* manpage: Stop creating a section directory on build manpage by default
(see :confval:`man_make_section_directory`)
Bugs fixed
----------
* viewcode: crashed if non importable modules found on parallel build
* Unknown node error for pending_xref_condition is raised if an extension
that does not support the node installs a missing-reference handler
Release 4.0.1 (released May 11, 2021)
=====================================
Bugs fixed
----------
* autodoc: crashed when ValueError is raised on generating signature
from a property of the class
* autosummary: warning is emitted if list value is set to
autosummary_generate
* html search: tags for search result are broken
* i18n: Babel emits errors when running compile_catalog
* py domain: The :canonical: option causes "more than one target for
cross-reference" warning
* websupport: UndefinedError is raised: 'css_tag' is undefined
Release 4.0.0 (released May 09, 2021)
=====================================
Dependencies
------------
4.0.0b1
* Drop python 3.5 support
* Drop docutils 0.12 and 0.13 support
* LaTeX: add ``tex-gyre`` font dependency
4.0.0b2
* Support docutils-0.17. Please notice it changes the output of HTML builder.
Some themes do not support it, and you need to update your custom CSS to
upgrade it.
Incompatible changes
--------------------
4.0.0b1
* autodoc: info-field-list is generated into the class description when
``autodoc_typehints='description'`` and ``autoclass_content='class'`` set
* extlinks: "%s" becomes required keyword in the link caption string
* domain: The ``Index`` class becomes subclasses of ``abc.ABC`` to indicate
methods that must be overridden in the concrete classes
* py domain: The structure of python objects is changed. A boolean value
is added to indicate that the python object is canonical one
* MathJax: The MathJax was changed from 2 to 3. Users using a custom
MathJax configuration may have to set the old MathJax path or update their
configuration for version 3. See :mod:`sphinx.ext.mathjax`.
* i18n: The msgid for alt text of image is changed
* napoleon: :confval:`napoleon_use_param` also affect "other parameters"
section
* manpage: Make a section directory on build manpage by default (see
:confval:`man_make_section_directory`)
* html: Change the default setting of
:confval:`html_codeblock_linenos_style` to ``'inline'``
* html search: search results are wrapped with ``<p>`` instead of
``<div>``
* html theme: Move a script tag for documentation_options.js in
basic/layout.html to ``script_files`` variable
* html theme: Move CSS tags in basic/layout.html to ``css_files`` variable
* html theme: Emit a warning for sphinx_rtd_theme-0.2.4 or older
* LaTeX: uplatex becomes a default setting of latex_engine for Japanese
documents
* py domain: ``:var:``, ``:cvar:`` and ``:ivar:`` fields do not create
cross-references
* The ``align`` attribute of ``figure`` and ``table`` nodes becomes
``None`` by default instead of ``'default'``
* LaTeX refactoring: split sphinx.sty into multiple files and rename
some auxiliary files created in ``latex`` build output repertory
* Use explicit title instead of <no title>
* The :file: option for csv-table directive now recognizes an absolute
path as a relative path from source directory
4.0.0b2
* Change the CSS classes on :rst:role:`cpp:expr` and
:rst:role:`cpp:texpr`.
Deprecated
----------
* :confval:`html_codeblock_linenos_style`
* ``favicon`` and ``logo`` variable in HTML templates
* ``sphinx.directives.patches.CSVTable``
* ``sphinx.directives.patches.ListTable``
* ``sphinx.directives.patches.RSTTable``
* ``sphinx.ext.autodoc.directive.DocumenterBridge.filename_set``
* ``sphinx.ext.autodoc.directive.DocumenterBridge.warn()``
* ``sphinx.registry.SphinxComponentRegistry.get_source_input()``
* ``sphinx.registry.SphinxComponentRegistry.source_inputs``
* ``sphinx.transforms.FigureAligner``
* ``sphinx.util.pycompat.convert_with_2to3()``
* ``sphinx.util.pycompat.execfile_()``
* ``sphinx.util.smartypants``
* ``sphinx.util.typing.DirectiveOption``
Features added
--------------
4.0.0b1
* autodoc: Support ``bound`` argument for TypeVar
* autodoc: Support typehints for properties
* autodoc: Allow to refer to a python class using its canonical name
when the class has two different names; a canonical name and an alias name
* autodoc: Add :confval:`autodoc_typehints_description_target` to control
the behavior of ``autodoc_typehints=description``
* autodoc: :confval:`autodoc_docstring_signature` will continue to look
for multiple signature lines without backslash character
* autosummary: Enable :confval:`autosummary_generate` by default
* extlinks: Allow %s in link caption string
* py domain: Add ``:canonical:`` option to python directives to describe
the location where the object is defined
* py domain: Add :confval:`python_use_unqualified_type_names` to suppress
the module name of the python reference if it can be resolved (experimental)
* py domain: Add :rst:dir:`py:property` directive to describe a property
* i18n: The alt text for image is translated by default (without
:confval:`gettext_additional_targets` setting)
* html: :confval:`html_favicon` and :confval:`html_logo` now accept URL
for the image
* html search: Support searching for 2characters word
* html theme: Allow to inherite the search page
* imgconverter: Show the error of the command availability check
* Add debug logs for change detection of sources and templates
* Emit a warning if toctree contains duplicated entries
* ``master_doc`` is now renamed to :confval:`root_doc`
* C++, add support for the C++20 spaceship operator, ``<=>``.
* A new node, ``sphinx.addnodes.pending_xref_condition`` has been added.
It can be used to choose appropriate content of the reference by conditions.
4.0.0b2
* autodoc: Super class having ``Any`` arguments causes nit-picky warning
* autodoc: TypeError is raised on processing broken metaclass
* autodoc: metadata of GenericAlias is not rendered as a reference in
py37+
* html: copy-range protection for doctests doesn't work in Safari
* LaTeX: imgconverter: conversion runs even if not needed
* py domain: Ellipsis in info-field-list causes nit-picky warning
* py domain: duplicated warning is emitted when both canonical and its
alias objects are defined on the document
* More CSS classes on domain descriptions, see :ref:`nodes` for details.
* mathjax: Rename :confval:`mathjax_config` to
:confval:`mathjax2_config` and add :confval:`mathjax3_config`
Bugs fixed
----------
4.0.0b1
* autodoc: Raises a warning if function has wrong __globals__ value
* autodoc: a TypeVar imported from other module is not resolved (in
Python 3.7 or above)
* autodoc: Failed to resolve types.TracebackType type annotation
* html: html_add_permalinks=None and html_add_permalinks="" are ignored
* html search: Paragraphs in search results are not identified as ``<p>``
* html theme: The translation of sphinx_rtd_theme does not work
* Emit a warning if a unknown domain is given for directive or role (ex.
``:unknown:doc:``)
* LaTeX: No wrapping for ``cpp:enumerator``
* LaTeX: backticks in code-blocks trigger latexpdf build warning (and font
change) with late TeXLive 2019
* LaTeX: Figures with no size defined get overscaled (compared to images
with size explicitly set in pixels) (fixed for ``'pdflatex'/'lualatex'`` only)
* LaTeX: The depth of bookmarks panel in PDF is not enough for navigation
* LaTeX: the fix to two minor Pygments LaTeXFormatter output issues ignore
Pygments style
* LaTeX: 3.5.0 ``verbatimmaxunderfull`` setting does not work as
expected
* LaTeX: missing line break in ``\pysigline``
* LaTeX: legacy ``\pysiglinewithargsret`` does not compute correctly
available horizontal space and should use a ragged right style
* LaTeX: "release" value with underscore leads to invalid LaTeX
* C++: remove the longest matching prefix in
:confval:`cpp_index_common_prefix` instead of the first that matches.
* C, properly reject function declarations when a keyword is used
as parameter name.
* viewcode: Failed to create back-links on parallel build
* C and C++, fix rendering of (member) function pointer types in
function parameter lists.
* C++, fix linking of names in array declarators, pointer to member
(function) declarators, and in the argument to ``sizeof...``.
* C, fix linking of names in array declarators.
4.0.0b2
* C, C++, fix ``KeyError`` when an ``alias`` directive is the first C/C++
directive in a file with another C/C++ directive later.
4.0.0b3
* html: Failed to add CSS files to the specific page
Revision 1.76 / (download) - annotate - [select for diffs], Fri Apr 16 05:56:27 2021 UTC (3 years ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2021Q3-base,
pkgsrc-2021Q3,
pkgsrc-2021Q2-base,
pkgsrc-2021Q2
Changes since 1.75: +2 -2
lines
Diff to previous 1.75 (colored) to selected 1.73 (colored)
py-sphinx: updated to 3.5.4 Release 3.5.4 (released Apr 11, 2021) ===================================== Dependencies ------------ * Restrict docutils to 0.16 Bugs fixed ---------- * autodoc: Async staticmethods and classmethods are considered as non async coroutine-functions with Python3.10 * html theme: The style are not applied with docutils-0.17 - toctree captions - The content of ``sidebar`` directive - figures
Revision 1.75 / (download) - annotate - [select for diffs], Tue Apr 6 15:45:44 2021 UTC (3 years ago) by adam
Branch: MAIN
Changes since 1.74: +8 -9
lines
Diff to previous 1.74 (colored) to selected 1.73 (colored)
py-sphinx: updated to 3.5.3
Release 3.5.3 (released Mar 20, 2021)
=====================================
Features added
--------------
* using UNIX path separator in image directive confuses Sphinx on Windows
Release 3.5.2 (released Mar 06, 2021)
=====================================
Bugs fixed
----------
* i18n: Crashed by broken translation messages in ES, EL and HR
* LaTeX: A custom LaTeX builder fails with unknown node error
* Exceptions raised in a Directive cause parallel builds to hang
Release 3.5.1 (released Feb 16, 2021)
=====================================
Bugs fixed
----------
* autodoc: AttributeError is raised on assigning __annotations__ on
read-only class
* html: minified js stemmers not included in the distributed package
* html: AttributeError is raised if CSS/JS files are installed via
:confval:`html_context`
* viewcode: ExtensionError is raised on incremental build after
unparsable python module found
Release 3.5.0 (released Feb 14, 2021)
=====================================
Dependencies
------------
* LaTeX: ``multicol`` (it is anyhow a required part of the official latex2e
base distribution)
Incompatible changes
--------------------
* Update Underscore.js to 1.12.0
* html: The config variable ``html_add_permalinks`` is replaced by
:confval:`html_permalinks` and :confval:`html_permalinks_icon`
Deprecated
----------
* pending_xref node for viewcode extension
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.good``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue``
* ``sphinx.builders.linkcheck.node_line_or_0()``
* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
* ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter``
* ``sphinx.ext.autodoc.importer.get_module_members()``
* ``sphinx.ext.autosummary.generate._simple_info()``
* ``sphinx.ext.autosummary.generate._simple_warn()``
* ``sphinx.writers.html.HTMLTranslator.permalink_text``
* ``sphinx.writers.html5.HTML5Translator.permalink_text``
Features added
--------------
* autodoc: autodata and autoattribute directives does not show right-hand
value of the variable if docstring contains ``:meta hide-value:`` in
info-field-list
* autodoc: Default values of overloaded functions are taken from actual
implementation if they're ellipsis
* autodoc: Support type union operator (PEP-604) in Python 3.10 or above
* autodoc: Allow to extend :confval:`autodoc_default_options` via
directive options
* html: kbd role generates customizable HTML tags for compound keys
* html: Allow to change the order of JS/CSS via ``priority`` parameter
for :meth:`Sphinx.add_js_file()` and :meth:`Sphinx.add_css_file()`
* html: Allow to add JS/CSS files to the specific page when an extension
calls ``app.add_js_file()`` or ``app.add_css_file()`` on
:event:`html-page-context` event
* html: Allow to use HTML permalink texts via
:confval:`html_permalinks_icon`
* html: Add permalink icons to glossary terms
* html search: performance issue with massive lists
* html search: Update JavaScript stemmer code to the latest version of
Snowball (v2.1.0)
* i18n: Allow to translate heading syntax in MyST-Parser
* imgconverter: Skip availability check if builder supports the image
type
* napoleon: Allow to change the style of custom sections using
:confval:`napoleon_custom_styles`
* napoleon: Type definitions in Google style docstrings are rendered as
references when :confval:`napoleon_preprocess_types` enabled
* mathjax: Include mathjax.js only on the document using equations
* py domain: Support type union operator (PEP-604)
* std domain: cross-reference for a rubric having inline item is broken
* std domain: Optimize case-insensitive match of term
* viewcode: Support incremental build
* Add :confval:`project_copyright` as an alias of :confval:`copyright`
* Now :confval:`highlight_language` supports multiple languages
* :rst:dir:`code-block` and :rst:dir:`literalinclude` supports automatic
dedent via no-argument ``:dedent:`` option
* C++, also hyperlink operator overloads in expressions and alias declarations.
* Allow production lists to refer to tokens from other production groups
* Show what extension (or module) caused it on errors on event handler
* C++: add ``maxdepth`` option to :rst:dir:`cpp:alias` to insert nested
declarations.
* C, add ``noroot`` option to :rst:dir:`c:alias` to render only nested
declarations.
* C++, add ``noroot`` option to :rst:dir:`cpp:alias` to render only nested
declarations.
Bugs fixed
----------
* apidoc: namespace module file is not generated if no submodules there
* autodoc: inherited-members doesn't work for instance attributes on super
class
* autodoc: ``:meta public:`` does not effect to variables
* autodoc: empty __all__ attribute is ignored
* autodoc: Failed to resolve struct.Struct type annotation
* autodoc: All variable comments in the module are ignored if the module
contains invalid type comments
* autodoc: Default values for overloaded functions are rendered as string
* autodoc: crashes when mocked decorator takes arguments
* autodoc: Uninitialized attributes in superclass are recognized as
undocumented
* autodoc: Failed to generate document if target module contains an
object that raises an exception on ``hasattr()``
* autosummary: mocked modules are documented as empty page when using
:recursive: option
* graphviz: Image node is not rendered if graph file is in subdirectory
* html: kbd role produces incorrect HTML when compound-key separators (-,
+ or ^) are used as keystrokes
* html: A type warning for html_use_opensearch is shown twice
* html: kbd role with "Caps Lock" rendered incorrectly
* html search: fix searching for terms containing + (Requires a custom
search language that does not split on +)
* html theme: Could not override globaltoc_maxdepth in theme.conf
* html: consecutive spaces are displayed as single space
* i18n: crashes with KeyError when translation message adds a new auto
footnote reference
* linkcheck: Fix race condition that could lead to checking the
availability of the same URL twice
* linkcheck: The docname for each hyperlink is not displayed
* sphinx-quickstart: questionare got Mojibake if libreadline unavailable
* texinfo: image files on the different directory with document are not
copied
* todo: Cross references in todolist get broken
* viewcode: module pages are generated for epub on incremental build
* viewcode: anchors are generated in incremental build after singlehtml
* viewcode: highlighted code is generated even if not referenced
* :confval:`highlight_options` is not working
* C, fix intersphinx lookup types for names in declarations.
* C, C++: in general fix intersphinx and role lookup types.
* :confval:`html_last_updated_fmt` does not support UTC offset (%z)
* :confval:`html_last_updated_fmt` generates wrong time zone for %Z
* ``download`` role creates duplicated copies when relative path is
specified
* (fifth item): LaTeX: footnotes from captions are not clickable,
and for manually numbered footnotes only first one with same number is
an hyperlink
* LaTeX with French babel and memoir crash: "Illegal parameter number
in definition of ``\FNH@prefntext``"
* LaTeX (docs): A potential display bug with the LaTeX generation step
in Sphinx (how to generate one-column index)
* LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX
* LaTeX: The :rst:role:`index` role and the glossary generate duplicate
entries in the LaTeX index (if both used for same term)
* LaTeX: wrong internal links in pdf to captioned code-blocks when
:confval:`numfig` is not True
* LaTeX: some indexed terms are ignored when using xelatex engine
(or pdflatex and :confval:`latex_use_xindy` set to True) with memoir class
* LaTeX: URLs as footnotes fail to show in PDF if originating from
inside function type signatures
* LaTeX: long words in narrow columns may not be hyphenated
* LaTeX: ``\titleformat`` last argument in sphinx.sty should be
bracketed, not braced (and is anyhow not needed)
* LaTex: code-block printed out of margin (see the opt-in LaTeX syntax
boolean :ref:`verbatimforcewraps <latexsphinxsetupforcewraps>` for use via
the :ref:`'sphinxsetup' <latexsphinxsetup>` key of ``latex_elements``)
* LaTeX: Remove substitution_reference nodes from doctree only on LaTeX
builds
* LaTeX: Restructure the index nodes inside title nodes only on LaTeX
builds
* LaTeX: potentially critical low level TeX coding mistake has gone
unnoticed so far
* C, :rst:dir:`c:alias` skip symbols without explicit declarations
instead of crashing.
* C, :rst:dir:`c:alias` give a warning when the root symbol is not declared.
* C, ``expr`` role should start symbol lookup in the current scope.
Release 3.4.3 (released Jan 08, 2021)
=====================================
Bugs fixed
----------
* autodoc: Failed to generate document if target module contains an
object that raises an exception on ``hasattr()``
Release 3.4.2 (released Jan 04, 2021)
=====================================
Bugs fixed
----------
* autodoc: Classes that inherit mocked class are not documented
* autodoc: The ``autodoc-process-docstring`` event is emitted to the
non-datadescriptors unexpectedly
* autodoc: AttributeError is raised on non-class object is passed to
autoclass directive
Release 3.4.1 (released Dec 25, 2020)
=====================================
Bugs fixed
----------
* autodoc: AttributeError is raised when using forward-reference type
annotations
* autodoc: TypeError is raised on checking slots attribute
* autodoc: Instance attributes are incorrectly added to Parent class
* autodoc: The ``autodoc-process-docstring`` event is emitted to the
alias classes unexpectedly
* autodoc: Unnecessary object comparision via ``__eq__`` method
* linkcheck: Fix PriorityQueue crash when link tuples are not
comparable
Release 3.4.0 (released Dec 20, 2020)
=====================================
Incompatible changes
--------------------
* autodoc: the signature of class constructor will be shown for decorated
classes, not a signature of decorator
Deprecated
----------
* The ``follow_wrapped`` argument of ``sphinx.util.inspect.signature()``
* The ``no_docstring`` argument of
``sphinx.ext.autodoc.Documenter.add_content()``
* ``sphinx.ext.autodoc.Documenter.get_object_members()``
* ``sphinx.ext.autodoc.DataDeclarationDocumenter``
* ``sphinx.ext.autodoc.GenericAliasDocumenter``
* ``sphinx.ext.autodoc.InstanceAttributeDocumenter``
* ``sphinx.ext.autodoc.SlotsAttributeDocumenter``
* ``sphinx.ext.autodoc.TypeVarDocumenter``
* ``sphinx.ext.autodoc.importer._getannotations()``
* ``sphinx.ext.autodoc.importer._getmro()``
* ``sphinx.pycode.ModuleAnalyzer.parse()``
* ``sphinx.util.osutil.movefile()``
* ``sphinx.util.requests.is_ssl_error()``
Features added
--------------
* autodoc: Allow to determine whether a member not included in
``__all__`` attribute of the module should be documented or not via
:event:`autodoc-skip-member` event
* autodoc: Parameters for generic class are not shown when super class is
a generic class and show-inheritance option is given (in Python 3.7 or above)
* autodoc: Add ``Documenter.config`` as a shortcut to access the config object
* autodoc: Add Optional[t] to annotation of function and method if a default
value equal to None is set.
* autodoc: Add ``:no-value:`` option to :rst:dir:`autoattribute` and
:rst:dir:`autodata` directive to suppress the default value of the variable
* autodoc: Support custom types defined by typing.NewType
* napoleon: Add :confval:`napoleon_attr_annotations` to merge type hints
on source code automatically if any type is specified in docstring
* napoleon: Support numpydoc's "Receives" section
* Add a new event :event:`warn-missing-reference` to custom warning
messages when failed to resolve a cross-reference
* Emit a detailed warning when failed to resolve a ``:ref:`` reference
* linkcheck: The builder now handles rate limits. See
:confval:`linkcheck_retry_on_rate_limit` for details.
Bugs fixed
----------
* autodoc: autodoc does not respect __signature__ of the class
* autodoc: the location of the warning is incorrect for inherited method
* autodoc: the signature of class constructor is incorrect if the class
is decorated
* autodoc: :confval:`autodoc_type_aliases` does not effect to variables
and attributes
* autodoc: autodata directive can't create document for PEP-526 based
type annotated variables
* autodoc: autoattribute directive can't create document for PEP-526
based uninitalized variables
* autodoc: autoattribute could not create document for __slots__
attributes
* autodoc: autoattribute could not create document for a GenericAlias as
class attributes correctly
* autodoc: autoattribute could not create document for a commented
attribute in alias class
* autodoc: autodoc_type_aliases doesn't work when autodoc_typehints is
set to "description"
* autodoc: autodoc_type_aliases doesn't work for the type annotation to
instance attributes
* autodoc: autodata and autoattribute directives do not display type
information of TypeVars
* autodoc: references to builtins not working in class aliases
* autodoc: ``__bool__`` method could be called
* autodoc: A typehint for the instance variable having type_comment on
super class is not displayed
* autodoc: a __slots__ attribute is not documented even having docstring
* autodoc: inherited-members doesn't work for instance attributes on super
class
* autosummary: non utf-8 reST files are generated when template contains
multibyte characters
* autosummary: summary extraction splits text after "el at." unexpectedly
* html: Wrong url_root has been generated on a document named "index"
* html search: Do not load ``language_data.js`` in non-search pages
* i18n: ``-D gettext_compact=0`` is no longer working
* graphviz: The layout option for graph and digraph directives don't work
* linkcheck: Use GET when HEAD requests cause Too Many Redirects, to
accommodate infinite redirect loops on HEAD
* Makefile: ``make clean`` with empty BUILDDIR is dangerous
* py domain: ``:type:`` and ``:rtype:`` gives false ambiguous class
lookup warnings
* std domain: Failed to parse an option that starts with bracket
* LaTeX: Prevent page brake in the middle of a seealso
* C, fix copying of AliasNode.
Release 3.3.1 (released Nov 12, 2020)
=====================================
Bugs fixed
----------
* autodoc: autoclass directive became slower than Sphinx-3.2
* autosummary: raise PycodeError when documenting python package
without __init__.py
* autosummary: autosummary_mock_imports causes slow down builds
* C, properly initialize attributes in empty symbols.
* i18n: Put system locale path after the paths specified by configuration
Release 3.3.0 (released Nov 02, 2020)
=====================================
Deprecated
----------
* ``sphinx.builders.latex.LaTeXBuilder.usepackages``
* ``sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref``
* ``sphinx.ext.autodoc.SingledispatchFunctionDocumenter``
* ``sphinx.ext.autodoc.SingledispatchMethodDocumenter``
Features added
--------------
* html: Show a better error message for failures on copying
html_static_files
* C: added a ``maxdepth`` option to :rst:dir:`c:alias` to insert
nested declarations.
* LaTeX: Allow to add LaTeX package via ``app.add_latex_package()`` until
just before writing .tex file
* manpage: Add :confval:`man_make_section_directory` to make a section
directory on build man page
* epub: Allow to suppress "duplicated ToC entry found" warnings from epub
builder using :confval:`suppress_warnings`.
* sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` option
* sphinx.testing: Register public markers in sphinx.testing.fixtures
* napoleon: use the obj role for all See Also items
* napoleon: Apply :confval:`napoleon_preprocess_types` to every field
* C and C++, show line numbers for previous declarations when duplicates are
detected.
* Remove substitution_reference nodes from doctree only on LaTeX builds
Bugs fixed
----------
* i18n: Add support for having single text domain
* i18n: Failed to override system message translation
* autodoc: AttributeError is raised when False value is passed to
autodoc_default_options
* autodoc: functools.cached_property is not considered as a property
* autodoc: parsing error is raised if some extension replaces docstring
by string not ending with blank lines
* autodoc: Wrong constructor signature for the class derived from
typing.Generic
* autodoc: TypeError is raised when annotation has invalid __args__
* autodoc: Tuple in default value is wrongly rendered
* autodoc: type aliases break type formatting of autoattribute
* autodoc: can't detect overloaded methods defined in other file
* autodoc: single-string __slots__ is not handled correctly
* autodoc: autodoc_typehints='none' does not effect to overloaded functions
* napoleon: description is disappeared when it contains inline literals
* napoleon: Potential of regex denial of service in google style docs
* LaTeX: pxjahyper loaded even when latex_engine is not platex
* LaTeX: 'oneside' classoption causes build warning
* intersphinx: Potential of regex denial of service by broken inventory
* sphinx-build: missing and redundant spacing (and etc) for console
output on building
* imgconverter: Check availability of imagemagick many times
* py domain: number in default argument value is changed from hexadecimal
to decimal
* html: Prevent arrow keys changing page when button elements are focused
* html search: Fix unnecessary load of images when parsing the document
* html theme: Line numbers misalign with code lines
* The highlight warning has wrong location in some builders (LaTeX,
singlehtml and so on)
* Eliminate Fancyhdr build warnings for oneside documents
* Failed to refer a token in productionlist if it is indented
* linkcheck: Report HTTP errors when ``linkcheck_anchors`` is ``True``
* linkcheck: take source directory into account for local files
* linkcheck: ``tel:`` schema hyperlinks are detected as errors
* linkcheck: An exit status is incorrect when links having unsupported
schema found
* C, add missing items to internal object types dictionary,
e.g., preventing intersphinx from resolving them.
* C, fix anon objects in intersphinx.
* C++, properly reject functions as duplicate declarations if a
non-function declaration of the same name already exists.
* C, fix references to function parameters.
Link to the function instead of a non-existing anchor.
* figure numbers are unexpectedly assigned to uncaptioned items
* make "inline" line numbers un-selectable
Testing
--------
* Support parallel build in sphinx.testing
Release 3.2.1 (released Aug 14, 2020)
=====================================
Features added
--------------
* napoleon: Add :confval:`napoleon_preprocess_types` to enable the type
preprocessor for numpy style docstrings
* C and C++, parse function attributes after parameters and qualifiers.
Bugs fixed
----------
* napoleon: Crashes during processing C-ext module
* napoleon: "Inline literal start-string without end-string" warning in
Numpy style Parameters section
* autodoc: KeyError is raised on documenting an attribute of the broken
class
* autodoc: AttributeError is raised on documenting an attribute on Python
3.5.2
* autodoc: NameError is raised when target code uses ``TYPE_CHECKING``
* C++, fix parsing of template template paramters
Release 3.2.0 (released Aug 08, 2020)
=====================================
Deprecated
----------
* ``sphinx.ext.autodoc.members_set_option()``
* ``sphinx.ext.autodoc.merge_special_members_option()``
* ``sphinx.writers.texinfo.TexinfoWriter.desc``
* C, parsing of pre-v3 style type directives and roles, along with the options
:confval:`c_allow_pre_v3` and :confval:`c_warn_on_allowed_pre_v3`.
Features added
--------------
* autodoc: Allow overriding of exclude-members in skip-member function
* autodoc: ``:private-member:`` can take an explicit list of member names
to be documented
* autosummary: Add :confval:`autosummary_filename_map` to avoid conflict
of filenames between two object with different case
* autosummary: Support instance attributes as a target of autosummary
directive
* html: Add :confval:`html_codeblock_linenos_style` to change the style
of line numbers for code-blocks
* C and C++, support parameterized GNU style attributes.
* napoleon: Add aliases Warn and Raise.
* napoleon: parse type strings and make them hyperlinks as possible. The
conversion rule can be updated via :confval:`napoleon_type_aliases`
* napoleon: Create a hyperlink for each the type of parameter when
:confval:`napoleon_use_params` is False
* C, added :rst:dir:`c:alias` directive for inserting copies
of existing declarations.
* html: inventory is broken if the docname contains a space
* html search: Allow searching for numbers
* html theme: Add a new option :confval:`globaltoc_maxdepth` to control
the behavior of globaltoc in sidebar
* i18n: Optimize the dependencies check on bootstrap
* i18n: :confval:`figure_language_filename` supports ``docpath`` token
* linkcheck: Support checks for local links
* setuptools: Link verbosity to distutils' -v and -q option
* doctest: Add ``:trim-doctest-flags:`` and ``:no-trim-doctest-flags:``
options to doctest, testcode and testoutput directives
* add ``:noindexentry:`` to the Python, C, C++, and Javascript domains.
Update the documentation to better reflect the relationship between this option
and the ``:noindex:`` option.
* C, add possibility of parsing of some pre-v3 style type directives and
roles and try to convert them to equivalent v3 directives/roles.
Set the new option :confval:`c_allow_pre_v3` to ``True`` to enable this.
The warnings printed from this functionality can be suppressed by setting
:confval:`c_warn_on_allowed_pre_v3`` to ``True``.
The functionality is immediately deprecated.
* C, add support for named variadic macro arguments.
* Allow to suppress "self referenced toctrees" warning
Bugs fixed
----------
* autodoc: TypeError is raised on mocking generic-typed classes
* autodoc: function signature is not shown when the function has a
parameter having ``inspect._empty`` as its default value
* autodoc: type annotations for overloaded functions are not resolved
* autodoc: An instance attribute cause a crash of autofunction directive
* autodoc: ``private-members`` option does not work for class attributes
* autodoc: Generator type annotation is wrongly rendered in py36
* autodoc: An uninitialized annotated instance variable is not documented
when ``:inherited-members:`` option given
* autodoc: A type hint for the instance variable defined at parent class
is not shown in the document of the derived class
* autodoc: An annotated instance variable on super class is not
documented when derived class has other annotated instance variables
* autosummary: cannot handle umlauts in function names
* autosummary: Failed to extract summary line when abbreviations found
* autosummary: Failed to extract correct summary line when docstring
contains a hyperlink target
* autosummary: "Module attributes" header is not translatable
* apidoc: An extra newline is generated at the end of the rst file if a
module has submodules
* napoleon: decorated special methods are not shown
* napoleon: parameters are not escaped for combined params in numpydoc
* napoleon: multiple paramaters declaration in numpydoc was wrongly
recognized when napoleon_use_params=True
* LaTeX: ``numfig_secnum_depth > 1`` leads to wrong figure links
* html theme: XML-invalid files were generated
* gettext: Wrong source info is shown when using rst_epilog
* linkcheck: HEAD requests are not used for checking
* i18n: Failed to add an explicit title to ``:ref:`` role on translation
* py domain: failed to resolve a type annotation for the attribute
* py domain: failed to parse a type annotation containing ellipsis
* std domain: option directive does not generate old node_id compatible
with 2.x or older
* i18n: The content of ``math`` directive is interpreted as reST on
translation
* i18n: The ``root`` element for :confval:`figure_language_filename` is
not a path that user specifies in the document
* texinfo: TypeError is raised for nested object descriptions
* texinfo: a warning not supporting desc_signature_line node is shown
* :rst:role:`abbr` role without an explanation will show the explanation
from the previous abbr role
* graphviz: graphviz.css was copied on building non-HTML document
* C and C++, removed ``noindex`` directive option as it did
nothing.
* Duplicated node IDs are generated if node has multiple IDs
* Symbols sections are appeared twice in the index page
* Fix circular import in sphinx.addnodes
* CSS: make "highlight" selector more robust
* C++, parse non-type template parameters starting with
a dependent qualified name.
* C, don't deepcopy the entire symbol table and make a mess every time an
enumerator is handled.
Release 3.1.2 (released Jul 05, 2020)
=====================================
Incompatible changes
--------------------
* autodoc: the signature of base function will be shown for decorated
functions, not a signature of decorator
Bugs fixed
----------
* autodoc: Failed to detect module when relative module name given
* autodoc: AttributeError is raised when non-class object is given to
the autoclass directive
* autodoc: KeyError is raised for invalid mark up when autodoc_typehints
is 'description'
* autodoc: crashed if the target name matches to both an attribute and
module that are same name
* autodoc: function signature becomes ``(*args, **kwargs)`` if the
function is decorated by generic decorator
* autosummary: generates broken stub files if the target code contains
an attribute and module that are same name
* viewcode: Failed to resolve viewcode references on 3rd party builders
* html theme: List items have extra vertical space
* html theme: Undesired interaction between "overflow" and "float"
Release 3.1.1 (released Jun 14, 2020)
=====================================
Incompatible changes
--------------------
* napoleon: a type for attribute are represented as typed field
Features added
--------------
* autodoc: Show detailed warning when type_comment is mismatched with its
signature
Bugs fixed
----------
* autodoc: Warnings raised on variable and attribute type annotations
* autodoc: EOFError is raised on parallel build
* autodoc: TypeError is raised for overloaded C-ext function
* autodoc: an object which descriptors returns is unexpectedly documented
* autodoc: wrong signature is shown for the function using contextmanager
* autosummary: generates broken stub files if the target code contains
an attribute and module that are same name
* napoleon: Warnings raised on variable and attribute type annotations
* sphinx.util.inspect causes circular import problem
Release 3.1.0 (released Jun 08, 2020)
=====================================
Dependencies
------------
* mathjax: Update to 2.7.5
Incompatible changes
--------------------
* imgconverter: Invoke "magick convert" command by default on Windows
Deprecated
----------
* The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has
been changed to Sphinx object
* ``sphinx.ext.autosummary.generate.AutosummaryRenderer`` takes an object type
as an argument
* The ``ignore`` argument of ``sphinx.ext.autodoc.Documenter.get_doc()``
* The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.
AutosummaryRenderer``
* The ``module`` argument of ``sphinx.ext.autosummary.generate.
find_autosummary_in_docstring()``
* The ``builder`` argument of ``sphinx.ext.autosummary.generate.
generate_autosummary_docs()``
* The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.
generate_autosummary_docs()``
* The ``ignore`` argument of ``sphinx.util.docstring.prepare_docstring()``
* ``sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()``
* ``sphinx.util.rpartition()``
Features added
--------------
* LaTeX: Make the ``toplevel_sectioning`` setting optional in LaTeX theme
* LaTeX: Allow to override papersize and pointsize from LaTeX themes
* LaTeX: Add :confval:`latex_theme_options` to override theme options
* Allow to suppress "circular toctree references detected" warnings using
:confval:`suppress_warnings`
* C, added scope control directives, :rst:dir:`c:namespace`,
:rst:dir:`c:namespace-push`, and :rst:dir:`c:namespace-pop`.
* autodoc: Suppress default value for instance attributes
* autodoc: consider a member public if docstring contains
``:meta public:`` in info-field-list
* autodoc: Allow to generate docs for singledispatch functions by
py:autofunction
* autodoc: Support final classes and methods
* autodoc: Support signatures defined by ``__new__()``, metaclasses and
builtin base classes
* autodoc: Support multiple signatures on docstring
* autodoc: Support GenericAlias in Python 3.7 or above
* autodoc: Support overloaded functions
* autodoc: Support TypeVar
* autosummary: headings in generated documents are not translated
* autosummary: Add ``:caption:`` option to autosummary directive to set a
caption to the toctree
* autosummary: Support module attributes
* autosummary: Add ``:recursive:`` option to autosummary directive
to generate stub files recursively
* autosummary: Add :confval:`autosummary_context` to add template
variables for custom templates
* html: Support nested <kbd> elements
* html theme: Add right margin to footnote/citation labels
* html theme: CSS spacing for code blocks with captions and line
numbers
* html theme: Add new options :confval:`globaltoc_collapse` and
:confval:`globaltoc_includehidden` to control the behavior of globaltoc in
sidebar
* html theme: Avoid clashes between sidebar and other blocks
* html theme: Relbar breadcrumb should contain current page
* html theme: A canonical URL is not escaped
* html theme: Avoid whitespace at the beginning of genindex.html
* html theme: Add a "clearer" at the end of the "body"
* html theme: Make admonition/topic/sidebar scrollable
* html theme: Add top and bottom margins to tables
* html theme: Add viewport meta tag for basic theme
* html theme: classic: default codetextcolor/codebgcolor doesn't override
Pygments
* C and C++: allow semicolon in the end of declarations.
* C++, parse parameterized noexcept specifiers.
* C++, parse expressions with user-defined literals.
* C++, parse trailing return types.
* py domain: Add ``:final:`` option to :rst:dir:`py:class:`,
:rst:dir:`py:exception:` and :rst:dir:`py:method:` directives
* py domain: Change a type annotation for variables to a hyperlink
* std domain: :rst:dir:`option` directive support arguments in the form
of ``foo[=bar]``
* napoleon: a type for attribute are represented like type annotation
* napoleon: overescaped trailing underscore on attribute
* linkcheck: Add :confval:`linkcheck_request_headers` to send custom HTTP
headers for specific host
* setuptools: Support ``--verbosity`` option
* Add ``allowed_exceptions`` parameter to ``Sphinx.emit()`` to allow
handlers to raise specified exceptions
* C++, parse (trailing) requires clauses.
Bugs fixed
----------
* autodoc: incremental build does not work for imported objects
* autodoc: annotations not to be shown for descriptors
* autodoc: Decorated inherited method has no documentation
* autodoc: The change of autodoc-process-docstring for variables is
cached unexpectedly
* autodoc: misdetects a sync function is async
* autodoc: failed to detect a classmethod on Enum class
* autodoc: a typehint contains spaces is wrongly rendered under
autodoc_typehints='description' mode
* autodoc: failed to import nested class
* autodoc: does not render correct signatures for built-in functions
* autodoc: ``Optional[Union[foo, bar]]`` is presented as
``Union[foo, bar, None]``
* autodoc: autofunction emits an unfriendly warning if an invalid object
specified
* autodoc: undecorated signature is shown for decorated functions
* autodoc: typo in the default value of autodoc_member_order
* autodoc: wrong value for :member-order: option is ignored silently
* autodoc: member-order="bysource" does not work for C module
* autodoc: member-order="bysource" does not work for a module having
__all__
* autodoc: wrong retann value is passed to a handler of
autodoc-proccess-signature
* autodoc: fails with ValueError when processing numpy objects
* autodoc: TypeError is raised on documenting singledispatch function
* autosummary: a nested class is indexed as non-nested class
* autosummary: autosummary directive emits warnings twices if failed to
import the target module
* autosummary: The template variable "members" contains imported members
even if :confval:`autossummary_imported_members` is False
* autosummary: The location of import failure warning is missing
* sphinx-autogen: crashes when custom template uses inheritance
* sphinx-autogen: crashes when template uses i18n feature
* sphinx-build: Wrong error message when outdir is not directory
* sphinx-quickstart: Fix multiple directory creation for nested relpath
* html: Bad alignment of equation links
* html theme: some themes does not respect background color of Pygments
style (agogo, haiku, nature, pyramid, scrolls, sphinxdoc and traditional)
* html theme: inconsistent padding in admonitions
* napoleon: bad parsing of inline code in attribute docstrings
* imgconverter: runs imagemagick once unnecessary for builders not
supporting images
* incorrectly renders consecutive backslashes for docutils-0.16
* handle errors on event handlers
* LaTeX: EN DASH disappears from PDF bookmarks in Japanese documents
* LaTeX: Anonymous indirect hyperlink target causes duplicated labels
* LaTeX: pdflatex crashed when URL contains a single quote
* py domain: The default value for positional only argument is not shown
* coverage: Add :confval:`coverage_show_missing_items` to show coverage
result to console
* C++, fix rendering and xrefs in nested names explicitly starting
in global scope, e.g., ``::A::B``.
* C, fix rendering and xrefs in nested names explicitly starting
in global scope, e.g., ``.A.B``.
* C and C++, don't crash during display stringification of unary
expressions and fold expressions.
Release 3.0.4 (released May 27, 2020)
=====================================
Bugs fixed
----------
* autodoc: parametrized types are shown twice for generic types
* autodoc: system defined TypeVars are shown in Python 3.9
* html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons
* md5 fails when OpenSSL FIPS is enabled
* release package does not contain ``CODE_OF_CONDUCT``
Release 3.0.3 (released Apr 26, 2020)
=====================================
Features added
--------------
* C, parse array declarators with static, qualifiers, and VLA specification.
Bugs fixed
----------
* autodoc: crashes if target object raises an error on accessing
its attributes
Release 3.0.2 (released Apr 19, 2020)
=====================================
Features added
--------------
* C, parse attributes and add :confval:`c_id_attributes`
and :confval:`c_paren_attributes` to support user-defined attributes.
Bugs fixed
----------
* py domain: fails with IndexError for empty tuple in type annotation
* py domain: keyword-only arguments are documented as having a default of
None
* std domain: :rst:role:`term` role could not match case-insensitively
* autodoc: empty tuple in type annotation is not shown correctly
* autodoc: Sphinx builds has been slower since 3.0.0 on mocking
* C++, fix spacing issue in east-const declarations.
* LaTeX: Xindy language options were incorrect
* sphinx crashes with ImportError on python3.5.1
Release 3.0.1 (released Apr 11, 2020)
=====================================
Incompatible changes
--------------------
* std domain: :rst:dir:`term` role becomes case sensitive
Bugs fixed
----------
* py domain: a reference to class ``None`` emits a nitpicky warning
* py domain: a return annotation ``None`` in the function signature is
not converted to a hyperlink when using intersphinx
* std domain: duplication warning for glossary terms is case insensitive
* C++, fix merging overloaded functions in parallel builds.
* autodoc: fails with ValueError when using autodoc_mock_imports
* autodoc: ``autodoc_typehints='description'`` doesn't suppress typehints
in signature for classes/methods
* autodoc: fails with AttributeError when an object returns non-string
object as a ``__doc__`` member
* crashed when giving a non-string object to logger
* html theme: Do not include xmlns attribute with HTML 5 doctype
* html theme: Escape some links in HTML templates
Release 3.0.0 (released Apr 06, 2020)
=====================================
Dependencies
------------
3.0.0b1
* LaTeX: drop dependency on :program:`extractbb` for image inclusion in
Japanese documents as ``.xbb`` files are unneeded by :program:`dvipdfmx`
since TeXLive2015
* babel-2.0 or above is available (Unpinned)
Incompatible changes
--------------------
3.0.0b1
* Drop features and APIs deprecated in 1.8.x
* autosummary: stub files are overwritten automatically by default. see
:confval:`autosummary_generate_overwrite` to change the behavior
* autodoc: the members of ``object`` class are not documented by default
when ``:inherited-members:`` and ``:special-members:`` are given.
* py domain: ``meta`` fields in info-field-list becomes reserved. They
are not displayed on output document now
* py domain: doctree of desc_parameterlist has been changed. The
argument names, annotations and default values are wrapped with inline node
* The structure of ``sphinx.events.EventManager.listeners`` has changed
* Due to the scoping changes for :rst:dir:`productionlist` some uses of
:rst:role:`token` must be modified to include the scope which was previously
ignored.
* Internal data structure of Python, reST and standard domains have
changed. The node_id is added to the index of objects and modules. Now they
contains a pair of docname and node_id for cross reference.
* C++ domain: Non intended behavior is removed such as ``say_hello_``
links to ``.. cpp:function:: say_hello()``
* js domain: Non intended behavior is removed such as ``parseInt_`` links
to ``.. js:function:: parseInt``
* rst domain: Non intended behavior is removed such as ``numref_`` links
to ``.. rst:role:: numref``
* py domain: Non intended behavior is removed such as ``say_hello_``
links to ``.. py:function:: say_hello()``
* py domain: Drop special cross reference helper for exceptions,
functions and methods
* The C domain has been rewritten, with additional directives and roles.
The existing ones are now more strict, resulting in new warnings.
* The attribute ``sphinx_cpp_tagname`` in the ``desc_signature_line`` node
has been renamed to ``sphinx_line_type``.
* double backslashes in domain directives are no longer replaced by
single backslashes as default. A new configuration value
:confval:`strip_signature_backslash` can be used by users to reenable it.
3.0.0 final
* ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()``
Deprecated
----------
3.0.0b1
* ``desc_signature['first']``
* ``sphinx.directives.DescDirective``
* ``sphinx.domains.std.StandardDomain.add_object()``
* ``sphinx.domains.python.PyDecoratorMixin``
* ``sphinx.ext.autodoc.get_documenters()``
* ``sphinx.ext.autosummary.process_autosummary_toc()``
* ``sphinx.parsers.Parser.app``
* ``sphinx.testing.path.Path.text()``
* ``sphinx.testing.path.Path.bytes()``
* ``sphinx.util.inspect.getargspec()``
* ``sphinx.writers.latex.LaTeXWriter.format_docclass()``
Features added
--------------
3.0.0b1
* autosummary: Add :confval:`autosummary_generate_overwrite` to overwrite
old stub file
* autodoc: ``:inherited-members:`` option takes a name of anchestor class
not to document inherited members of the class and uppers
* autodoc: consider a member private if docstring contains
``:meta private:`` in info-field-list
* autodoc: Support Annotated type (PEP-593)
* autodoc: Support singledispatch functions and methods
* autodoc: :confval:`autodoc_typehints` accepts ``"description"``
configuration. It shows typehints as object description
* apidoc: Propagate ``--maxdepth`` option through package documents
* glossary: emit a warning for duplicated glossary entry
* domain: Register hyperlink target for index page automatically
* std domain: emit a warning for duplicated generic objects
* py domain: Add new event: :event:`object-description-transform`
* py domain: Do not emit nitpicky warnings for built-in types
* py domain: Support lambda functions in function signature
* py domain: Allow to make a style for arguments of functions and methods
* py domain: Emit a warning on describing a python object if the
entry is already added as the same name
* py domain: type annotations in singature are converted to cross refs
* Support priority of event handlers. For more detail, see
:py:meth:`.Sphinx.connect()`
* Implement the scoping for :rst:dir:`productionlist` as indicated
in the documentation.
* Support backslash line continuation in :rst:dir:`productionlist`.
* config: Allow to show an error message from conf.py via ``ConfigError``
* html: :confval:`html_scaled_image_link` will be disabled for images having
``no-scaled-link`` class
* Add CSS class indicating its domain for each desc node
* latex: Use babel for Chinese document when using XeLaTeX
* LaTeX: Support LaTeX Theming (experimental)
* LaTeX: Add LaTeX styling macro for :rst:role:`kbd` role
* genindex: Show "main" index entries at first
* linkcheck: writes all links to ``output.json``
* html search: full text search can be disabled for individual document
using ``:nosearch:`` file-wide metadata
* html search: Allow to override JavaScript splitter via
``SearchLanguage.js_splitter_code``
* html theme: Add a theme option: ``pygments_dark_style`` to switch the
style of code-blocks in dark mode
* The C domain has been rewritten adding for example:
- Cross-referencing respecting the current scope.
- Possible to document anonymous entities.
- More specific directives and roles for each type of entitiy,
e.g., handling scoping of enumerators.
- New role :rst:role:`c:expr` for rendering expressions and types
in text.
* Added ``SphinxDirective.get_source_info()``
and ``SphinxRole.get_source_info()``.
* sphinx-build: Emit a warning if multiple files having different file
extensions for same document found
3.0.0 final
* Added ``ObjectDescription.transform_content()``.
Bugs fixed
----------
3.0.0b1
* C++, fix cross reference lookup in certain cases involving
function overloads.
* C++, fix cross reference lookup when a directive contains multiple
declarations.
* C++, suppress warnings for directly dependent typenames in cross references
generated automatically in signatures.
* autodoc: Incorrect handling of nested class names on show-inheritance
* autodoc: error message for invalid directive options has wrong location
* autodoc: info-field-list is wrongly generated from type hints into the
class description even if ``autoclass_content='class'`` set
* autodoc: a cython-function is not recognized as a function
* inheritance_diagram: Incorrect handling of nested class names
* ``code-block:: guess`` does not work
* html: source_suffix containing dot leads to wrong source link
* html: Resizing SVG image fails with ValueError
* html search: Fix use of ``html_file_suffix`` instead of
``html_link_suffix`` in search results
* html theme: ``bizstyle`` does not support ``sidebarwidth``
* singlehtml: Path to images broken when master doc is not in source root
* std domain: Fix whitespaces are suppressed on referring GenericObject
* console: use bright colors instead of bold
* C, parse array types.
* C, parse function pointers even in complex types.
* sphinx-build: Sphinx crashes if output directory exists as a file
* sphinx-build: Ignore bdb.BdbQuit when handling exceptions
* napoleon: Attributes and Methods sections ignore :noindex: option
3.0.0 final
* autosummary: crashed when :confval:`autosummary_generate` is False
* autosummary: raises UnboundLocalError when unknown module given
* C++, alternate operator spellings are now supported.
* C, alternate operator spellings are now supported.
* C++, comma operator in expressions, pack expansion in template
argument lists, and more comprehensive error messages in some cases.
* C, C++, fix crash and wrong duplicate warnings related to anon symbols.
* Escape first "!" in a cross reference linking no longer possible
* py domain: The index entry generated by ``py:function`` directive is
different with one from ``index`` directive with "builtin" type
* capital characters are not allowed for node_id
* epub: duplicated node_ids are generated
* html: a width of table was ignored on HTML builder
* Incorrect argument is passed for :event:`env-get-outdated` handlers
* autodoc: a signature of cython-function is not recognized well
* autodoc: ``__wrapped__`` functions are not documented correctly
* intersphinx: ValueError is raised when an extension sets up
:confval:`intersphinx_mapping` on :event:`config-inited` event
* Sphinx builds has been slower since 2.4.0 on debug mode
Revision 1.74 / (download) - annotate - [select for diffs], Mon Aug 31 23:07:07 2020 UTC (3 years, 7 months ago) by wiz
Branch: MAIN
CVS Tags: pkgsrc-2021Q1-base,
pkgsrc-2021Q1,
pkgsrc-2020Q4-base,
pkgsrc-2020Q4,
pkgsrc-2020Q3-base,
pkgsrc-2020Q3
Changes since 1.73: +3 -2
lines
Diff to previous 1.73 (colored)
*: switch to versioned_dependencies.mk for py-setuptools
Revision 1.73 / (download) - annotate - [selected], Mon Mar 9 18:38:59 2020 UTC (4 years, 1 month ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2020Q2-base,
pkgsrc-2020Q2,
pkgsrc-2020Q1-base,
pkgsrc-2020Q1
Changes since 1.72: +2 -2
lines
Diff to previous 1.72 (colored)
py-sphinx: updated to 2.4.4 Release 2.4.4: Bugs fixed * LaTeX: platex cause error to build image directive with target url * Sphinx builds has been slower since 2.4.0
Revision 1.72 / (download) - annotate - [select for diffs], Sat Feb 29 15:48:04 2020 UTC (4 years, 1 month ago) by adam
Branch: MAIN
Changes since 1.71: +2 -2
lines
Diff to previous 1.71 (colored) to selected 1.73 (colored)
py-sphinx: updated to 2.4.3 Release 2.4.3: Bugs fixed * autodoc: ``*args`` and ``**kwarg`` in type comments are not handled properly * autodoc: classmethod coroutines are not detected * intersphinx: ``:attr:`` reference to property is broken * html search: Search breaks/hangs when built with dirhtml builder * todo: emit doctree-resolved event with non-document node incorrectly
Revision 1.71 / (download) - annotate - [select for diffs], Fri Feb 21 09:07:44 2020 UTC (4 years, 1 month ago) by adam
Branch: MAIN
Changes since 1.70: +2 -2
lines
Diff to previous 1.70 (colored) to selected 1.73 (colored)
py-sphinx: updated to 2.4.2 Release 2.4.2: Bugs fixed * autodoc: ``autodoc.typehints`` crashed when variable has unbound object as a value * autodoc: separator for keyword only arguments is not shown * autodoc: IndexError is raised on suppressed type_comment found * autodoc: typehints extension does not support parallel build * autodoc: TypeError is raised on fetching type annotations * crashed when extension assigns a value to ``env.indexentries`` * text: Remove debug print * viewcode: Avoid to crash when non-python code given
Revision 1.70 / (download) - annotate - [select for diffs], Mon Feb 17 20:25:43 2020 UTC (4 years, 2 months ago) by adam
Branch: MAIN
Changes since 1.69: +3 -5
lines
Diff to previous 1.69 (colored) to selected 1.73 (colored)
py-sphinx: updated to 2.4.1 Release 2.4.1: Bugs fixed * html: crashed when on scaling SVG images which have float dimentions * autodoc: TypeError: ãàÏÈetset_descriptorãàobject is not iterable Release 2.4.0: Deprecated The decode argument of sphinx.pycode.ModuleAnalyzer() sphinx.directives.other.Index sphinx.environment.temp_data['gloss_entries'] sphinx.environment.BuildEnvironment.indexentries sphinx.environment.collectors.indexentries.IndexEntriesCollector sphinx.ext.apidoc.INITPY sphinx.ext.apidoc.shall_skip() sphinx.io.FiletypeNotFoundError sphinx.io.get_filetype() sphinx.pycode.ModuleAnalyzer.encoding sphinx.roles.Index sphinx.util.detect_encoding() sphinx.util.get_module_source() sphinx.util.inspect.Signature sphinx.util.inspect.safe_getmembers() sphinx.writers.latex.LaTeXTranslator.settings.author sphinx.writers.latex.LaTeXTranslator.settings.contentsname sphinx.writers.latex.LaTeXTranslator.settings.docclass sphinx.writers.latex.LaTeXTranslator.settings.docname sphinx.writers.latex.LaTeXTranslator.settings.title sphinx.writers.latex.ADDITIONAL_SETTINGS sphinx.writers.latex.DEFAULT_SETTINGS sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG Features added * inheritance_diagram: Make the background of diagrams transparent * duration: Add sphinx.ext.durations to inspect which documents slow down the build * LaTeX: Support a nested table * LaTeX: Allow to override LATEXOPTS and LATEXMKOPTS via environment variable * graphviz: Support :class: option * html: :scale: option of image/figure directive not working for SVG images (imagesize-1.2.0 or above is required) * imgconverter: Support illustrator file (.ai) to .png conversion * autodoc: Support Positional-Only Argument separator (PEP-570 compliant) * autodoc: Support type annotations for variables * autodoc: Add new event: autodoc-before-process-signature * autodoc: Support type_comment style (ex. # type: (str) -> str) annotation (python3.8+ or typed_ast is required) * autodoc: Support instance variables without defaults (PEP-526) * autodoc: Add a new extension sphinx.ext.autodoc.typehints. It shows typehints as object description if autodoc_typehints = "description" set. This is an experimental extension and it will be integrated into autodoc core in Sphinx-3.0 * SphinxTranslator now calls visitor/departure method for super node class if visitor/departure method for original node class not found * Add new event: object-description-transform * py domain: py:data and py:attribute take new options named :type: and :value: to describe its type and initial value * py domain: :py:attr: is able to refer properties again * apidoc: Add -q option for quiet mode Bugs fixed * html: Remove redundant type=ãàÙÕext/javascriptãàfrom <script> elements * html: SVG image is not layouted as float even if aligned * autodoc: failed to read the source codes encoeded in cp1251 * latex: warning for babel shown twice * latex: LaTeX compilation falls into infinite loop (wrapfig issue) * latex: :reversed: option for toctree does not effect to LaTeX build * Wrong node-ids are generated in glossary directive * apidoc: misdetects module name for .so file inside module * apidoc: private members are not shown even if --private given * apidoc: Support a python package consisted of __init__.so file * napoleon: fails to parse tilde in :exc: role * gettext: Absolute path used in message catalogs * autodoc: nested partial functions are not listed * autodoc: partial functions imported from other modules are listed as module members without :impoprted-members: option * autodoc: Trailing comma in :members:: option causes cryptic warning * autosummary: autosummary_imported_members is ignored on generating a stub file for submodule * linkcheck: redirect is treated as an error * HTML template: If navigation_with_keys option is activated, modifier keys are ignored, which means the feature can interfere with browser features * std domain: CanãàÑÕ assign numfig-numbers for custom container nodes * std domain: enumerated nodes are marked as duplicated when extensions call note_explicit_target() * dirhtml: Cross references are broken via intersphinx and :doc: role * C++: - DonãàÑÕ crash when using the struct role in some cases. - DonãàÑÕ warn when using the var/member role for function parameters. - Render call and braced-init expressions correctly. * Filenames of images generated by sphinx.transforms.post_transforms.images.ImageConverter or its subclasses (used for latex build) are now sanitized, to prevent broken paths
Revision 1.69 / (download) - annotate - [select for diffs], Tue Dec 31 10:38:46 2019 UTC (4 years, 3 months ago) by adam
Branch: MAIN
Changes since 1.68: +3 -3
lines
Diff to previous 1.68 (colored) to selected 1.73 (colored)
py-sphinx: updated to 2.3.1 Release 2.3.1: Bugs fixed * sphinx-autogen: raises AttributeError Release 2.3.0: Incompatible changes * end-before option of literalinclude directive does not match the first line of the code block. * Change default User-Agent header to "Sphinx/X.Y.Z requests/X.Y.Z python/X.Y.Z". It can be changed via user_agent. * text: content of admonitions starts after a blank line Deprecated sphinx.builders.gettext.POHEADER sphinx.io.SphinxStandaloneReader.app sphinx.io.SphinxStandaloneReader.env sphinx.util.texescape.tex_escape_map sphinx.util.texescape.tex_hl_escape_map_new sphinx.writers.latex.LaTeXTranslator.no_contractions Features added * C++, support bit-fields. * html: Eliminate prompt characters of doctest block from copyable text * html: Use favicon for OpenSearch if available * html theme: agogo theme now supports rightsidebar option * Add PEP-561 Support * latex: Allow to load additonal LaTeX packages via extrapackages key of latex_elements * Add new config variable: user_agent * LaTeX: have backslash also be an inline literal word wrap break character * LaTeX: Support upLaTeX as a new latex_engine (experimental) * Improve a warning message when extensions are not parallel safe * Improve Intersphinx performance for multiple remote inventories. * apidoc: .so file support * autosummary: emit autodoc-skip-member event on generating stub file * i18n: make explicit titles in toctree translatable * linkcheck: Add linkcheck_auth option to provide authentication information when doing linkcheck builds * linkcheck: Handles HTTP 308 Permanent Redirect * html: Wrap section number in span tag * gettext: Add gettext_last_translator' and :confval:`gettext_language_team to customize headers of POT file Bugs fixed * LaTeX: Longtable before header has incorrect distance (refs: latex3/latex2e#173) * LaTeX: Avoid section names at the end of a page * LaTeX: Do not replace unicode characters by LaTeX macros on unicode supported LaTeX engines: ¶, §, ±, ãà superscript and subscript digits go through ãà×Âs isãà(as default OpenType font supports them) * linkcheck: Be defensive and handle newly defined HTTP error code * linkcheck: Failure on parsing content * image URLs containing data: causes gettext builder crashed * i18n: Error when compiling message catalogs on Hindi * i18n: KeyError is raised if section title and table title are same * i18n: rst_prolog breaks the translation * mathbase: Some deprecated functions have removed * autodoc: mock object does not work as a class decorator * epub: Wrong internal href fragment links * Allow not to install sphinx.testing as runtime (mainly for ALT Linux) * html: search result was broken with empty html_file_suffix * LaTeX does not wrap long code lines at backslash character * LaTeX: PDF build breaks if admonition of danger type contains code-block long enough not to fit on one page * LaTeX: code-block in a danger type admonition can easily spill over bottom of page * texinfo: Code examples broken following ãà×Ôidebarãà* An orphan warning is emitted for included document on Windows. Thanks to @drillan * Fix smartypants module calls re.sub() with wrong options * HTML search: If a search term is partially matched in the title and fully matched in a text paragraph on the same page, the search does not include this match. * config.py shouldnãàÑÕ pop extensions from overrides * text: extra spaces are inserted to hyphenated words on folding lines * LaTeX: xelatex converts straight double quotes into right curly ones (shows when smartquotes is False) * LaTeX: even with smartquotes off, PDF output transforms straight quotes and consecutive hyphens into curly quotes and dashes * LaTeX: multi-line display of authors on title page has ragged edges * Sphinx crashes with docutils-0.16b0 * sphinx-build: A console message is wrongly highlighted * sphinx-build: -D option does not considers 0 and 1 as a boolean value
Revision 1.68 / (download) - annotate - [select for diffs], Sun Dec 8 21:56:23 2019 UTC (4 years, 4 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2019Q4-base,
pkgsrc-2019Q4
Changes since 1.67: +2 -2
lines
Diff to previous 1.67 (colored) to selected 1.73 (colored)
py-sphinx: updated to 2.2.2 Release 2.2.2: Incompatible changes * For security reason of python, parallel mode is disabled on macOS and Python3.8+ Bugs fixed * LaTeX: 2019-10-01 LaTeX release breaks :file:`sphinxcyrillic.sty` * i18n: French, Hindi, Chinese, Japanese and Korean translation messages has been broken * parallel build causes AttributeError on macOS and Python3.8
Revision 1.67 / (download) - annotate - [select for diffs], Sat Oct 26 23:03:57 2019 UTC (4 years, 5 months ago) by adam
Branch: MAIN
Changes since 1.66: +2 -2
lines
Diff to previous 1.66 (colored) to selected 1.73 (colored)
py-sphinx: updated to 2.2.1 Release 2.2.1: Bugs fixed * LaTeX: Undefined control sequence ``\sphinxmaketitle`` * LaTeX not well configured for Greek language as main language * validation of html static paths and extra paths no longer throws an error if the paths are in different directories
Revision 1.66 / (download) - annotate - [select for diffs], Mon Oct 21 21:01:35 2019 UTC (4 years, 5 months ago) by adam
Branch: MAIN
Changes since 1.65: +18 -20
lines
Diff to previous 1.65 (colored) to selected 1.73 (colored)
py-sphinx: updated to 2.2.0
Release 2.2.0:
Incompatible changes
apidoc: template files are renamed to .rst_t
html: Field lists will be styled by grid layout
Deprecated¶
sphinx.domains.math.MathDomain.add_equation()
sphinx.domains.math.MathDomain.get_next_equation_number()
The info and warn arguments of sphinx.ext.autosummary.generate.generate_autosummary_docs()
sphinx.ext.autosummary.generate._simple_info()
sphinx.ext.autosummary.generate._simple_warn()
sphinx.ext.todo.merge_info()
sphinx.ext.todo.process_todo_nodes()
sphinx.ext.todo.process_todos()
sphinx.ext.todo.purge_todos()
Features added
* graphviz: :graphviz_dot: option is renamed to :layout:
* html: emit a warning if html_static_path and html_extra_path directories are inside output directory
* html: Add a label to search input for accessability purposes
* apidoc: Add --templatedir option
* Add override argument to app.add_autodocumenter()
* imgmath: let imgmath_use_preview work also with the SVG format for images rendering inline math
* LaTeX: refactor visit_enumerated_list() to use \sphinxsetlistlabels
* quickstart: Use https://docs.python.org/3/ for default setting of intersphinx_mapping
* sphinx-build: give reasons why rebuilded
Bugs fixed
py domain: duplicated warning does not point the location of source code
* html: Sphinx never updates a copy of html_logo even if original file has changed
* html theme: scrollbar is hard to see on classic theme and macOS
* linkcheck: Consider HTTP 503 response as not an error
* Make generated download links reproducible
* UnboundLocalError is raised if broken extension installed
* autodoc: autodoc_inherit_docstrings does not effect to __init__() and __new__()
* autodoc: autodoc_member_order does not refer order of imports when 'bysource' order
* autodoc: missing type annotation for variadic and keyword parameters
* autodoc: Formatting issues with autodoc_typehints=ÑÏoneãà* autodoc: crashed when target code contains custom method-like objects
* autosummary: crashed with wrong autosummary_generate setting
* autosummary: crashes without no autosummary_generate setting
* LaTeX: autonumbered list can not be customized in LaTeX since Sphinx 1.8.0
* Failed to load last environment object when extension added
* Invalid sort in pair index
* last_updated wrongly assumes timezone as UTC
* std domain: option directive registers an index entry for each comma separated option
* sphinx-build: Escaped characters in error messages
* doctest comments not getting trimmed since Sphinx 1.8.0
* glossary: Wrong hyperlinks are generated for non alphanumeric terms
* i18n: classifiers of definition list are not translated with docutils-0.15
* DocFieldTransformer raises AttributeError when given directive is not a subclass of ObjectDescription
Release 2.1.2:
Bugs fixed
* custom lexers fails highlighting when syntax error
* info field lists are incorrectly recognized
Release 2.1.1 (released Jun 10, 2019)
Incompatible changes
* autodoc: Stop to generate document for undocumented module variables
Bugs fixed
* LaTeX: admonitions of note type can get separated from immediately preceding section title by pagebreak
* autodoc: crashed when autodocumenting classes with __slots__ = None
* autodoc: generates docs for ãà×Ðptional importãàÙÆd modules as variables
* autosummary: crashed when generating document of properties
* napoleon: docstrings for properties are not processed
* napoleon: ãà׶nknown target nameãàerror if variable name ends with underscore
* apidoc: missing blank lines between modules
Release 2.1.0:
Incompatible changes
Ignore filenames without file extension given to Builder.build_specific() API directly
* The anchor of term in glossary directive is changed if it is consisted by non-ASCII characters
* html: Centering tables by default using CSS
* latex: xelatex and xeCJK are used for Chinese documents by default
Sphinx.add_lexer() now takes a Lexer class instead of instance. An instance of lexers are still supported until Sphinx-3.x.
Deprecated
sphinx.builders.latex.LaTeXBuilder.apply_transforms()
sphinx.builders._epub_base.EpubBuilder.esc()
sphinx.directives.Acks
sphinx.directives.Author
sphinx.directives.Centered
sphinx.directives.Class
sphinx.directives.CodeBlock
sphinx.directives.Figure
sphinx.directives.HList
sphinx.directives.Highlight
sphinx.directives.Include
sphinx.directives.Index
sphinx.directives.LiteralInclude
sphinx.directives.Meta
sphinx.directives.Only
sphinx.directives.SeeAlso
sphinx.directives.TabularColumns
sphinx.directives.TocTree
sphinx.directives.VersionChange
sphinx.domains.python.PyClassmember
sphinx.domains.python.PyModulelevel
sphinx.domains.std.StandardDomain._resolve_citation_xref()
sphinx.domains.std.StandardDomain.note_citations()
sphinx.domains.std.StandardDomain.note_citation_refs()
sphinx.domains.std.StandardDomain.note_labels()
sphinx.environment.NoUri
sphinx.ext.apidoc.format_directive()
sphinx.ext.apidoc.format_heading()
sphinx.ext.apidoc.makename()
sphinx.ext.autodoc.importer.MockFinder
sphinx.ext.autodoc.importer.MockLoader
sphinx.ext.autodoc.importer.mock()
sphinx.ext.autosummary.autolink_role()
sphinx.ext.imgmath.DOC_BODY
sphinx.ext.imgmath.DOC_BODY_PREVIEW
sphinx.ext.imgmath.DOC_HEAD
sphinx.transforms.CitationReferences
sphinx.transforms.SmartQuotesSkipper
sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()
sphinx.util.node.find_source_node()
sphinx.util.i18n.find_catalog()
sphinx.util.i18n.find_catalog_files()
sphinx.util.i18n.find_catalog_source_files()
For more details, see deprecation APIs list.
Features added
Add a helper class sphinx.transforms.post_transforms.SphinxPostTransform
Add helper methods
PythonDomain.note_module()
PythonDomain.note_object()
SphinxDirective.set_source_info()
* Support --keep-going with BuildDoc setup command
math directive now supports :class: option
todo: todo directive now supports :name: option
Enable override via environment of SPHINXOPTS and SPHINXBUILD Makefile variables
* autodoc: Unable to document bound instance methods exported as module functions
* autodoc: autodoc_default_options now supports imported-members option
* autodoc: Support coroutine
* autodoc: Support abstractmethod
* autodoc: Support attributes in __slots__. For dict-style __slots__, autodoc considers values as a docstring of the attribute
* autodoc: Add autodoc_typehints to suppress typehints from signature
* autodoc: automodule directive now handles undocumented module level variables
* autosummary: Add autosummary_imported_members to display imported members on autosummary
* make clean is catastrophically broken if building into ãàãà* Support %O% environment variable in make.bat
* py domain: Add :async: option to py:function directive
* py domain: Add new options to py:method directive
:abstractmethod:
:async:
:classmethod:
:property:
:staticmethod:
rst domain: Add directive:option directive to describe the option for directive
* html: Add a label to search form for accessability purposes
* html: Consistent and semantic CSS for signatures
* The rawsource property of production nodes now contains the full production rule
* autosectionlabel: Allow suppression of warnings
coverage: Support a new coverage_ignore_pyobjects option
* latex: Support to build Chinese documents
Bugs fixed
* Inappropriate node_id has been generated by glossary directive if term is consisted by non-ASCII characters
* ifconfig: contents after headings are not shown
commented term in glossary directive is wrongly recognized
* rst domain: rst:directive directive generates waste space
* py domain: Module index (py-modindex.html) has duplicate titles
* man: invalid output when doctest follows rubric
* ãàשyperlink target is not referencedãàmessage is shown even if referenced
* autodoc: tab_width setting of docutils has been ignored
* autodoc: crashes with a plain Tuple on Python 3.6 and 3.5
* autosummary: autosummary table gets confused by complex type hints
* autosummary: confused by an argument having some kind of default value
Generated Makefiles lack a final EOL
* extlinks: Cannot escape angle brackets in link caption
* linkcheck: Send commonly used User-Agent
* html search: failed to search document with haiku and scrolls themes
* html search: Fix the ranking of search results
* Wrong year is returned for SOURCE_DATE_EPOCH
* image directive crashes by unknown image format
* C++, allow 8 and 9 in hexadecimal integer literals.
* Fix the string in quickstart for ãàÏÑathãàargument of parser
LaTeX: Figures in admonitions produced errors
Release 2.0.1:
Bugs fixed
LaTeX: some system labels are not translated
RemovedInSphinx30Warning is marked as pending
deprecation warnings are not emitted
sphinx.application.CONFIG_FILENAME
sphinx.builders.htmlhelp
viewcode_import
* C++, properly parse full xrefs that happen to have a short xref as prefix
* napoleon: AttributeError is raised for raised section having references
* circular import error on importing SerializingHTMLBuilder
* LaTeX: ãàÏÓeleasenameãàsetting for latex_elements is ignored
* html: Search function is broken with 3rd party themes
* html: HTML5Translator crashed with invalid field node
* html theme: The style of field lists has changed in bizstyle theme
Release 2.0.0:
Dependencies
2.0.0b1
LaTeX builder now depends on TeX Live 2015 or above.
LaTeX builder (with 'pdflatex' latex_engine) will process Unicode Greek letters in text (not in math mark-up) via the text font and will not escape them to math mark-up. See the discussion of the 'fontenc' key of latex_elements; such (optional) support for Greek adds, for example on Ubuntu xenial, the texlive-lang-greek and (if default font set-up is not modified) cm-super(-minimal) as additional Sphinx LaTeX requirements.
LaTeX builder with latex_engine set to 'xelatex' or to 'lualatex' requires (by default) the FreeFont fonts, which in Ubuntu xenial are provided by package fonts-freefont-otf, and e.g. in Fedora 29 via package texlive-gnu-freefont.
requests 2.5.0 or above
The six package is no longer a dependency
The sphinxcontrib-websupport package is no longer a dependency
Some packages are separated to sub packages:
sphinxcontrib.applehelp
sphinxcontrib.devhelp
sphinxcontrib.htmlhelp
sphinxcontrib.jsmath
sphinxcontrib.serializinghtml
sphinxcontrib.qthelp
Incompatible changes
2.0.0b1
Drop python 2.7 and 3.4 support
Drop docutils 0.11 support
Drop features and APIs deprecated in 1.7.x
The default setting for master_doc is changed to 'index' which has been longly used as default of sphinx-quickstart.
LaTeX: Move message resources to sphinxmessage.sty
LaTeX: Stop using \captions<lang> macro for some labels
LaTeX: for 'xelatex' and 'lualatex', use the FreeFont OpenType fonts as default choice
LaTeX: 'xelatex' and 'lualatex' now use \small in code-blocks (due to FreeMono character width) like 'pdflatex' already did (due to Courier character width). You may need to adjust this via latex_elements 'fvset' key, in case of usage of some other OpenType fonts
LaTeX: Greek letters in text are not escaped to math mode mark-up, and they will use the text font not the math font. The LGR font encoding must be added to the 'fontenc' key of latex_elements for this to work (only if it is needed by the document, of course).
LaTeX: setting the language to 'en' triggered Sonny option of fncychap, now it is Bjarne to match case of no language specified.
* doctest: Follow highlight_language on highlighting doctest block. As a result, they are highlighted as python3 by default.
The order of argument for HTMLTranslator, HTML5Translator and ManualPageTranslator are changed
LaTeX: hard-coded redefinitions of \l@section and \l@subsection formerly done during loading of 'manual' docclass get executed later, at time of \sphinxtableofcontents. This means that custom user definitions from LaTeX preamble now get overwritten. Use \sphinxtableofcontentshook to insert custom user definitions. See Macros.
quickstart: Simplify generated conf.py
* quickstart: some questions are removed. They are still able to specify via command line options
websupport: unbundled from sphinx core. Please use sphinxcontrib-websupport
C++, the visibility of base classes is now always rendered as present in the input. That is, private is now shown, where it was ellided before.
LaTeX: graphics inclusion of oversized images rescales to not exceed the text width and height, even if width and/or height option were used.
epub: epub_title defaults to the project option
* All tables and figures without align option are displayed to center
* html: Output HTML5 by default
2.0.0b2
texinfo: image files are copied into name-figure directory
Deprecated
2.0.0b1
Support for evaluating Python 2 syntax is deprecated. This includes configuration files which should be converted to Python 3.
The arguments of EpubBuilder.build_mimetype(), EpubBuilder.build_container(), EpubBuilder.bulid_content(), EpubBuilder.build_toc() and EpubBuilder.build_epub()
The arguments of Epub3Builder.build_navigation_doc()
The config variables
html_experimental_html5_writer
The encoding argument of autodoc.Documenter.get_doc(), autodoc.DocstringSignatureMixin.get_doc(), autodoc.DocstringSignatureMixin._find_signature(), and autodoc.ClassDocumenter.get_doc() are deprecated.
The importer argument of sphinx.ext.autodoc.importer._MockModule
The nodetype argument of sphinx.search.WordCollector. is_meta_keywords()
The suffix argument of env.doc2path() is deprecated.
The string style base argument of env.doc2path() is deprecated.
The fallback to allow omitting the filename argument from an overridden IndexBuilder.feed() method is deprecated.
sphinx.addnodes.abbreviation
sphinx.application.Sphinx._setting_up_extension
sphinx.builders.epub3.Epub3Builder.validate_config_value()
sphinx.builders.html.SingleFileHTMLBuilder
sphinx.builders.htmlhelp.HTMLHelpBuilder.open_file()
sphinx.cmd.quickstart.term_decode()
sphinx.cmd.quickstart.TERM_ENCODING
sphinx.config.check_unicode()
sphinx.config.string_classes
sphinx.domains.cpp.DefinitionError.description
sphinx.domains.cpp.NoOldIdError.description
sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decoded
sphinx.ext.autodoc.importer._MockImporter
sphinx.ext.autosummary.Autosummary.warn()
sphinx.ext.autosummary.Autosummary.genopt
sphinx.ext.autosummary.Autosummary.warnings
sphinx.ext.autosummary.Autosummary.result
sphinx.ext.doctest.doctest_encode()
sphinx.io.SphinxBaseFileInput
sphinx.io.SphinxFileInput.supported
sphinx.io.SphinxRSTFileInput
sphinx.registry.SphinxComponentRegistry.add_source_input()
sphinx.roles.abbr_role()
sphinx.roles.emph_literal_role()
sphinx.roles.menusel_role()
sphinx.roles.index_role()
sphinx.roles.indexmarkup_role()
sphinx.testing.util.remove_unicode_literal()
sphinx.util.attrdict
sphinx.util.force_decode()
sphinx.util.get_matching_docs()
sphinx.util.inspect.Parameter
sphinx.util.jsonimpl
sphinx.util.osutil.EEXIST
sphinx.util.osutil.EINVAL
sphinx.util.osutil.ENOENT
sphinx.util.osutil.EPIPE
sphinx.util.osutil.walk()
sphinx.util.PeekableIterator
sphinx.util.pycompat.NoneType
sphinx.util.pycompat.TextIOWrapper
sphinx.util.pycompat.UnicodeMixin
sphinx.util.pycompat.htmlescape
sphinx.util.pycompat.indent
sphinx.util.pycompat.sys_encoding
sphinx.util.pycompat.terminal_safe()
sphinx.util.pycompat.u
sphinx.writers.latex.ExtBabel
sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()
sphinx.writers.latex.LaTeXTranslator.babel_defmacro()
sphinx.writers.latex.LaTeXTranslator.collect_footnotes()
sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()
sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()
sphinx.writers.text.TextTranslator._make_depart_admonition()
template variables for LaTeX template
logo
numfig_format
pageautorefname
translatablestrings
For more details, see deprecation APIs list.
Features added
2.0.0b1
* The search results preview of generated HTML documentation is reader-friendlier: instead of showing the snippets as raw reStructuredText markup, Sphinx now renders the corresponding HTML. This means the Sphinx extension Sphinx: pretty search results is no longer necessary. Note that changes to the search function of your custom or 3rd-party HTML template might overwrite this improvement.
* autodoc: Support suppress_warnings
* autodoc: autodoc_default_options supports member-order
* autodoc: Display readable names in type annotations for mocked objects
* autodoc: autodoc_default_options accepts True as a value
* autodoc: Add autodecorator directive for decorators
* autosummary: Add autosummary_mock_imports to mock external libraries on importing targets
* htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix
* text: Support complex tables (colspan and rowspan)
LaTeX: support rendering (not in math, yet) of Greek and Cyrillic Unicode letters in non-Cyrillic document even with 'pdflatex' as latex_engine
* The versionadded, versionchanged and deprecated directives are now generated with their own specific CSS classes (added, changed and deprecated, respectively) in addition to the generic versionmodified class.
* apidoc: Add ãàÅÆxtensions option to sphinx-apidoc
* C++, added an alias directive for inserting lists of declarations, that references existing declarations (e.g., for making a synopsis).
C++: add cpp:struct to complement cpp:class.
* the HTML search considers words that contain a search term of length three or longer a match.
* epub: Show warning for duplicated ToC entries
* Allow to omit an argument for code-block directive. If omitted, it follows highlight or highlight_language
* html: Add html4_writer to use old HTML4 writer
* HTML search: A placeholder for the search summary prevents search result links from changing their position when the search terminates. This makes navigating search results easier.
* linkcheck also checks remote images exist
* githubpages: create CNAME file for custom domains when html_baseurl set
* autosectionlabel: restrict the labeled sections by new config value; autosectionlabel_maxdepth
Bugs fixed
2.0.0b1
* LaTeX: writer should not translate Greek unicode, but use textgreek package
* LaTeX: PDF does not build with default font config for Russian language and 'xelatex' or 'lualatex' as latex_engine
* LaTeX: Greek letters in section titles disappear from PDF bookmarks
* LaTeX: Unicode Greek letters in math directive break PDF build (fix requires extra set-up, see latex_elements 'textgreek' key and/or latex_engine setting)
* LaTeX: should the Bjarne style of fncychap be used for English also if passed as language option?
* LaTeX: (lualatex only) escaping of > by \textgreater{} is not enough as \textgreater{}\textgreater{} applies TeX-ligature
LaTeX: project name is not escaped if latex_documents omitted
LaTeX: authors are not shown if latex_documents omitted
HTML: Invalid HTML5 file is generated for a glossary having multiple terms for one description
QtHelp: OS dependent path separator is used in .qhp file
HTML search: search always returns nothing when multiple search terms are used and one term is shorter than three characters
2.0.0b2
* html: Anchor links are not added to figures
* html: Defer searchindex.js rather than loading it via ajax
* html: Table cells and list items have large margins
* linenothreshold option for highlight directive was ignored
texinfo: make install-info causes syntax error
texinfo: make install-info fails on macOS
* texinfo: image files are not copied on make install-info
* A cross reference in heading is rendered as literal
* C++, fix cpp:alias problems in LaTeX (and singlehtml)
* classes attribute of citation_reference node is lost
AssertionError is raised when custom citation_reference node having classes attribute refers missing citation
* Support code directive
C++, fix parsing of braced initializers.
* AttributeError is raised for old styled index nodes
* inheritance_diagram: correctly describe behavior of parts option in docs, allow negative values.
* i18n: Captions missing in translations for hidden TOCs
2.0.0 final
* py domain: unexpected prefix is generated
Testing
2.0.0b1
Stop to use SPHINX_TEST_TEMPDIR envvar
2.0.0b2
Add a helper function: sphinx.testing.restructuredtext.parse()
Revision 1.65 / (download) - annotate - [select for diffs], Sat Aug 24 04:48:02 2019 UTC (4 years, 7 months ago) by ryoon
Branch: MAIN
CVS Tags: pkgsrc-2019Q3-base,
pkgsrc-2019Q3
Changes since 1.64: +3 -4
lines
Diff to previous 1.64 (colored) to selected 1.73 (colored)
Revert wrong workaround and require py-packaging>=19.1nb1 explicitly Bump PKGREVISION. From wiz@, thank you.
Revision 1.64 / (download) - annotate - [select for diffs], Fri Aug 23 13:18:52 2019 UTC (4 years, 7 months ago) by ryoon
Branch: MAIN
Changes since 1.63: +3 -1
lines
Diff to previous 1.63 (colored) to selected 1.73 (colored)
Fix runtime error when building docs in mail/notmuch, bump PKGREVISION
Revision 1.63 / (download) - annotate - [select for diffs], Thu May 2 09:27:09 2019 UTC (4 years, 11 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2019Q2-base,
pkgsrc-2019Q2
Changes since 1.62: +2 -2
lines
Diff to previous 1.62 (colored) to selected 1.73 (colored)
Forget about Python 3.4
Revision 1.62 / (download) - annotate - [select for diffs], Sun Mar 10 13:36:02 2019 UTC (5 years, 1 month ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2019Q1-base,
pkgsrc-2019Q1
Changes since 1.61: +2 -2
lines
Diff to previous 1.61 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.8.5 1.8.5: Bugs fixed * LaTeX: Remove extraneous space after author names on PDF title page * LaTeX: A cross reference to definition list does not work * LaTeX: TypeError is raised when invalid latex_elements given * LaTeX: images having a target are concatenated to next line * LaTeX: images having a target are not aligned even if specified * imgconverter: Including multipage PDF fails * autodoc: autofunction emits a warning for method objects * graphviz: Ensure the graphviz filenames are reproducible * doctest: skipif option may remove the code block from documentation * :name: option for math directive causes a crash * intersphinx: ValueError on failure reporting * changes: Fix UnboundLocalError when any module found
Revision 1.61 / (download) - annotate - [select for diffs], Tue Feb 5 12:54:23 2019 UTC (5 years, 2 months ago) by adam
Branch: MAIN
Changes since 1.60: +2 -2
lines
Diff to previous 1.60 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.8.4 Release 1.8.4: Bugs fixed * latex: no bold checkmark (ãü available. * with the documentation language set to Chinese, English words could not be searched. * LaTeX: user numfig_format is stripped of spaces and may cause build failure * C++, fix hyperlinks for declarations involving east cv-qualifiers. * C++, fix duplicate declaration error on function templates with constraints in the return type. * C++, parse unary right fold expressions and binary fold expressions. * pycode could not handle egg files on windows * KeyError: 'DOCUTILSCONFIG' when running build * LaTeX: PDF build broken by inclusion of image taller than page height in an admonition * "make html" does not read and build "po" files in "locale" dir * :scale: image option may break PDF build if image in an admonition * LaTeX: modified PDF layout since September 2018 TeXLive update of :file:parskip.sty * LaTeX: duplicated labels are generated for sections * versionadded directive causes crash with Python 3.5.0 * autodoc: autodoc_mock_imports conflict with metaclass on Python 3.7 * texinfo: a section title . is not allowed
Revision 1.60 / (download) - annotate - [select for diffs], Mon Dec 31 12:10:44 2018 UTC (5 years, 3 months ago) by adam
Branch: MAIN
Changes since 1.59: +2 -2
lines
Diff to previous 1.59 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.8.3
Release 1.8.3:
Features added
* LaTeX: it is possible to insert custom material to appear on back of title
page, see discussion of 'maketitle' key of :confval:latex_elements
('manual' docclass only)
Bugs fixed
* mathjax: Use CDN URL for "latest" version by default
* html search does not work with some 3rd party themes
* LaTeX, caption package incompatibility since Sphinx 1.6
* autodoc: incremental build is broken when builtin modules are imported
* qthelp: index.html missing in QtHelp
* linkcheck: crashes for a hyperlink containing multibyte character
* DOC: Fix some mistakes in :doc:/latex
* LaTeX: sphinxVerbatim requires explicit "hllines" set-up since 1.6.6
* C++, fix parsing of floating point literals.
* C++, fix assertion in partial builds with duplicates.
* quickstart: sphinx-quickstart fails when $LC_ALL is empty
* Default conf.py is not PEP8-compliant
* LaTeX: document class \maketitle is overwritten with no
possibility to use original meaning in place of Sphinx custom one
* apidoc: wrong help for --tocfile
* todo: crashed if todo is defined in TextElement
* htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files
* htmlhelp: broken .hhk file generated when title contains a double quote
Revision 1.59 / (download) - annotate - [select for diffs], Tue Nov 13 11:30:40 2018 UTC (5 years, 5 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2018Q4-base,
pkgsrc-2018Q4
Changes since 1.58: +2 -2
lines
Diff to previous 1.58 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.8.2 Release 1.8.2: Incompatible changes * Do not include MathJax.js and jsmath.js unless it is really needed Features added * Show appropriate deprecation warnings Bugs fixed * latex: enumerated list causes a crash with recommonmark * sphinx-build fails to build docs w/ Python < 3.5.2 * latex: wrong \label positioning for figures with a legend * C++, fix assertion when a symbol is declared more than twice. * gettext: crashed with broken template * csv-table directive with file option in included file is broken * autodoc: unable to find type hints for a functools.partial * autodoc: unable to find type hints for unresolvable Forward references * incompatible math_block node has been generated * Fix ensuredir() in case of pre-existing file * graphviz Correctly deal with non-existing static dir * i18n: multiple footnote_references referring same footnote causes duplicated node_ids * latex: footnote_references generated by extension causes LaTeX builder crashed * make all-pdf fails with old xindy version * quickstart: --no-batchfile isn't honored * texinfo: multiline rubrics are broken * texinfo: multiline citations are broken
Revision 1.58 / (download) - annotate - [select for diffs], Mon Sep 24 08:21:50 2018 UTC (5 years, 6 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2018Q3-base,
pkgsrc-2018Q3
Changes since 1.57: +2 -2
lines
Diff to previous 1.57 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.8.1 Release 1.8.1: Incompatible changes LaTeX \pagestyle commands have been moved to the LaTeX template. No changes in PDF, except possibly if \sphinxtableofcontents, which contained them, had been customized in conf.py. Bugs fixed * Incorrect default path for sphinx-build -d/doctrees files * autodoc emits deprecation warning for autodoc_default_flags * lambda object causes PicklingError on storing environment * Sphinx fails to build with syntax error in Python 2.7.5 * add latexpdf to make.bat for non make-mode * Autodoc does not work with enum subclasses with properties/methods * autodoc: crashed on modules importing eggs * latex: ImportError: cannot import name ãàÏ¥EFAULT_SETTINGSãà* autodoc: autofunction emits a warning for callable objects * Fix TypeError in error message when override is prohibited * PDF builds of ãàÏÉowtoãàdocuments have no page numbers * mathbase: math_role and MathDirective was disappeared in 1.8.0 * latex: Index has disappeared from PDF for Japanese documents * py domain: :type: field canãàÑÕ process :term: references * py domain: TypeError has been raised for class attribute
Revision 1.57 / (download) - annotate - [select for diffs], Thu Sep 13 07:36:52 2018 UTC (5 years, 7 months ago) by adam
Branch: MAIN
Changes since 1.56: +2 -2
lines
Diff to previous 1.56 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.8.0
Release 1.8.0:
Dependencies
1.8.0b1
* LaTeX: :confval:latex_use_xindy, if True (default for
xelatex/lualatex), instructs make latexpdf to use :program:xindy
for general index. Make sure your LaTeX distribution includes it.
Incompatible changes
1.8.0b2
* html theme: refer pygments_style settings of HTML themes
preferentially
* The URL of download files are changed
* quickstart: Makefile and make.bat are not overwritten if exists
1.8.0b1
* the :py:mod:sphinx.ext.graphviz: extension runs dot in the
directory of the document being built instead of in the root directory of
the documentation.
* extensions which stores any data to environment should return the
version of its env data structure as metadata. In detail, please see
:ref:ext-metadata.
* Sphinx expects source parser modules to have supported file formats as
Parser.supported attribute
* The default value of :confval:epub_author and :confval:epub_publisher are
changed from 'unknown' to the value of :confval:author. This is same as
a conf.py file sphinx-build generates.
* The gettext_compact attribute is removed from document.settings
object. Please use config.gettext_compact instead.
* The processing order on reading phase is changed. smart_quotes, sphinx
domains, :event:doctree-read event and versioning doctrees are invoked
earlier than so far. For more details, please read a description of
:py:meth:.Sphinx.add_transform()
* All substitution_definition nodes are removed from doctree on
reading phase
* docutils.conf on $HOME and /etc directories are ignored. Only
docutils.conf on confdir is refered.
* :samp: role supports to escape curly braces with backslash
* The files under :confval:html_static_path are excluded from source
files.
* latex: Use \sphinxcite for citation references instead \hyperref
* The config value viewcode_import is renamed to
:confval:viewcode_follow_imported_members
* latex: :confval:latex_show_pagerefs does not add pagerefs for
citations
* latex: Now "rubric" elements are rendered as unnumbered section title
* html: The anchor for productionlist tokens has been changed
* Modifying a template variable script_files in templates is allowed now.
Please use app.add_js_file() instead.
* Save environment object also with only new documents
* qthelp builder allows dashes in :confval:qthelp_namespace
* LaTeX: with lualatex or xelatex use by default :program:xindy as
UTF-8 able replacement of :program:makeindex. After
upgrading Sphinx, please clean latex build repertory of existing project
before new build.
* html: hlist items are now aligned to top
* highlightlang directive is processed on resolving phase
* latex: LaTeX template has been chaned. Following elements are moved
into the template:
- \begin{document}
- shorthandoff variable
- maketitle variable
- tableofcontents variable
Deprecated
1.8.0b2
* sphinx.io.SphinxI18nReader.set_lineno_for_reporter() is deprecated
* sphinx.io.SphinxI18nReader.line is deprecated
* sphinx.util.i18n.find_catalog_source_file() has changed; the
*gettext_compact* argument has been deprecated
* sphinx.util.images.guess_mimetype() has changed; the *content*
argument has been deprecated
1.8.0b1
* :confval:source_parsers is deprecated
* :confval:autodoc_default_flags is deprecated
* quickstart: --epub option becomes default, so it is deprecated
* Drop function based directive support. For now, Sphinx only supports class
based directives.
* sphinx.util.docutils.directive_helper() is deprecated
* sphinx.cmdline is deprecated
* sphinx.make_mode is deprecated
* sphinx.locale.l_() is deprecated
* helper function warn() for HTML themes is deprecated
* app.override_domain() is deprecated
* app.add_stylesheet() is deprecated
* app.add_javascript() is deprecated
* app.import_object() is deprecated
* app.add_source_parser() has changed; the *suffix* argument has been
deprecated
* sphinx.versioning.prepare() is deprecated
* Config.__init__() has changed; the *dirname*, *filename* and *tags*
argument has been deprecated
* Config.check_types() is deprecated
* Config.check_unicode() is deprecated
* sphinx.application.CONFIG_FILENAME is deprecated
* highlightlang directive is deprecated
* BuildEnvironment.load() is deprecated
* BuildEnvironment.loads() is deprecated
* BuildEnvironment.frompickle() is deprecated
* env.read_doc() is deprecated
* env.update() is deprecated
* env._read_serial() is deprecated
* env._read_parallel() is deprecated
* env.write_doctree() is deprecated
* env._nitpick_ignore is deprecated
* env.versionchanges is deprecated
* env.dump() is deprecated
* env.dumps() is deprecated
* env.topickle() is deprecated
* env.note_versionchange() is deprecated
* sphinx.writers.latex.Table.caption_footnotetexts is deprecated
* sphinx.writers.latex.Table.header_footnotetexts is deprecated
* sphinx.writers.latex.LaTeXTranslator.footnotestack is deprecated
* sphinx.writers.latex.LaTeXTranslator.in_container_literal_block is deprecated
* sphinx.writers.latex.LaTeXTranslator.next_section_ids is deprecated
* sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids is deprecated
* sphinx.writers.latex.LaTeXTranslator.restrict_footnote() is deprecated
* sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote() is deprecated
* sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids() is deprecated
* sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids() is deprecated
* sphinx.writers.latex.LaTeXTranslator.check_latex_elements() is deprecated
* sphinx.writers.latex.LaTeXTranslator.bibitems is deprecated
* sphinx.writers.latex.LaTeXTranslator.hlsettingstack is deprecated
* sphinx.writers.latex.ExtBabel.get_shorthandoff() is deprecated
* sphinx.writers.html.HTMLTranslator.highlightlang is deprecated
* sphinx.writers.html.HTMLTranslator.highlightlang_base is deprecated
* sphinx.writers.html.HTMLTranslator.highlightlangopts is deprecated
* sphinx.writers.html.HTMLTranslator.highlightlinenothreshold is deprecated
* sphinx.writers.html5.HTMLTranslator.highlightlang is deprecated
* sphinx.writers.html5.HTMLTranslator.highlightlang_base is deprecated
* sphinx.writers.html5.HTMLTranslator.highlightlangopts is deprecated
* sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold is deprecated
* sphinx.ext.mathbase extension is deprecated
* sphinx.ext.mathbase.math node is deprecated
* sphinx.ext.mathbase.displaymath node is deprecated
* sphinx.ext.mathbase.eqref node is deprecated
* sphinx.ext.mathbase.is_in_section_title() is deprecated
* sphinx.ext.mathbase.MathDomain is deprecated
* sphinx.ext.mathbase.setup_math() is deprecated
* sphinx.directives.other.VersionChanges is deprecated
* sphinx.highlighting.PygmentsBridge.unhighlight() is deprecated
* sphinx.ext.mathbase.get_node_equation_number() is deprecated
* sphinx.ext.mathbase.wrap_displaymath() is deprecated
* The trim_doctest_flags argument of sphinx.highlighting.PygmentsBridge
is deprecated
Features added
1.8.0b2
* Ensure frozen object descriptions are reproducible
* apidoc: Add --tocfile option to change the filename of ToC
1.8.0b1
* Add :event:config-inited event
* Add sphinx.config.Any to represent the config value accepts any type of
value
* :confval:source_suffix allows a mapping fileext to file types
* Add :confval:author as a configuration value
* imgconverter: Support to convert GIF to PNG
* sphinx-build command supports i18n console output
* Add app.add_message_catalog() and sphinx.locale.get_translations() to
support translation for 3rd party extensions
* helper function warning() for HTML themes is added
* Add Domain.enumerable_nodes to manage own enumerable nodes for domains
(experimental)
* Add a new keyword argument override to Application APIs
* LaTeX: new key 'fvset' for :confval:latex_elements. For
XeLaTeX/LuaLaTeX its default sets fanvyvrb to use normal, not small,
fontsize in code-blocks
* Add :confval:html_css_files and :confval:epub_css_files for adding CSS
files from configuration
* Add :confval:html_js_files for adding JS files from configuration
* Ensure set object descriptions are reproducible.
* Allow to override :confval:numfig_format partially. Full definition
is not needed.
* Improve warning messages during including
* LaTeX: separate customizability of :rst:role:guilabel and
:rst:role:menuselection
* Add Config.read() classmethod to create a new config object from
configuration file
* Wrap graphviz diagrams in <div> tag
* viewcode: Add :event:viewcode-find-source and
:event:viewcode-follow-imported to load source code without loading
* napoleon: Add strings to translation file for localisation
* Display a warning when invalid values are passed to linenothreshold
option of highlight directive
* C++:
- Add a cpp:texpr role as a sibling to cpp:expr.
- Add support for unions.
- add support for anonymous entities using names staring with @.
- add support for (most) character literals.
- Cross-referencing entities inside primary templates is supported,
and now properly documented.
- add new cross-referencing format for cpp:any and cpp:func roles,
for referencing specific function overloads.
* MathJax should be loaded with async attribute
* html: Output canonical_url metadata if :confval:html_baseurl set
* autosummary: expose inherited_members to template
* mathjax: Add :confval:mathjax_options to give options to script tag
for mathjax
* latex: Don't overwrite .tex file if document not changed
* latex: Add alphanumeric enumerated list support
* Add :confval:latex_use_xindy for UTF-8 savvy indexing, defaults to True
if :confval:latex_engine is 'xelatex' or 'lualatex'.
* SphinxLoggerAdapter.info() now supports location parameter
* setuptools: support nitpicky option
* autoclass directive supports nested class
* Add app.add_html_math_renderer() to register a math renderer for HTML
* Apply :confval:trim_doctest_flags to all builders (cf. text, manpages)
* linkcheck: Add better Accept header to HTTP client
* sphinx-build: Add --keep-going option to show all warnings
* Add :rst:role:math:numref role to refer equations (Same as :rst:role:eq)
* quickstart: epub builder is enabled by default
* Add :confval:singlehtml_sidebars to configure sidebars for singlehtml
builder
* doctest: Skip doctest conditionally
* autodoc: emit a warning for invalid typehints
* autodoc: Add :confval:autodoc_default_options which accepts
option values as dict
Bugs fixed
1.8.0b2
* html: search box overrides to other elements if scrolled
* i18n: warnings for translation catalogs have wrong line numbers
* latex: cross references has been broken by multiply labeled objects
* C++, fixes for symbol addition and lookup. Lookup should no longer break
in partial builds.
* download reference to remote file is not displayed
* html theme: pygments_style of theme was overrided by conf.py
by default
* toctree shows confusible warning when document is excluded
* autodoc: :members: causes :special-members: not to be shown
* autodoc: ImportError is replaced by AttributeError for deeper module
* Incorrect links with :download:, duplicate names, and
parallel builds
* autodoc: failed to analyze source code in egg package
* Sphinx crashes if unknown po file exists
1.8.0b1
* i18n: message catalogs were reset on each initialization
* latex: footnote inside footnote was not rendered
* i18n: fix lang_COUNTRY not fallback correctly for IndexBuilder. Thanks
to Shengjing Zhu.
* productionlist directive generates invalid IDs for the tokens
* (lualatex) PDF build fails if indexed word starts with Unicode character
* latex: index headings "Symbols" and "Numbers" not internationalized
* sphinx-build: Handle errors on scanning documents
* epub: spine has been broken when "self" is listed on toctree
* autosummary does not understand docstring of module level attributes
* C++, prevent nested declarations in functions to avoid lookup problems.
* C++, add missing isPack method for certain template parameter types.
* C++, parse attributes on declerators as well.
* C++, parse delete expressions and basic new expressions as well.
* graphviz: SVGs do not adapt to the column width
Features removed
1.8.0b1
* sphinx.ext.pngmath extension
Documentation
1.8.0b1
* Fix wrong make.bat option for internationalization.
* napoleon: add admonitions added by 4613 to the docs.
Revision 1.56 / (download) - annotate - [select for diffs], Thu Sep 6 09:26:43 2018 UTC (5 years, 7 months ago) by adam
Branch: MAIN
Changes since 1.55: +2 -2
lines
Diff to previous 1.55 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.7.9 Release 1.7.9: Features added * Make generated texinfo files reproducible by sorting the anchors Bugs fixed * crashed on incremental build if document uses include directive
Revision 1.55 / (download) - annotate - [select for diffs], Wed Aug 29 06:49:04 2018 UTC (5 years, 7 months ago) by adam
Branch: MAIN
Changes since 1.54: +2 -2
lines
Diff to previous 1.54 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.7.8 Release 1.7.8: Incompatible changes * The type of env.included has been changed to dict of set Bugs fixed * intersphinx: crashed if invalid url given * manpage: crashed when invalid docname is specified as man_pages * autodoc: Any typehint causes formatting error * "document isn't included in any toctree" warning on rebuild with generated files * quickstart: escape sequence has been displayed with MacPorts' python
Revision 1.54 / (download) - annotate - [select for diffs], Tue Aug 21 07:02:09 2018 UTC (5 years, 7 months ago) by adam
Branch: MAIN
Changes since 1.53: +2 -3
lines
Diff to previous 1.53 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.7.7 Release 1.7.7: Bugs fixed * document not in toctree warning when including files only for parallel builds * LaTeX: reduce "Token not allowed in a PDF string" hyperref warnings in latex console output * LaTeX: suppress "remreset Warning: The remreset package is obsolete" in latex console output with recent LaTeX * PDF output: usage of PAPER environment variable is broken since Sphinx 1.5 * LaTeX: fix the :confval:`latex_engine` documentation regarding Latin Modern font with XeLaTeX/LuaLateX * autodoc: Fix wrong type annotations for complex typing * autodoc: Optional types are wrongly rendered * autodoc crashed by ForwardRef types * autodoc: No docs generated for functools.partial functions * autodoc: ``getargspec()`` raises NameError for invalid typehints * imgmath: math_number_all causes equations to have two numbers in html * sphinx-quickstart blank prompts in PowerShell
Revision 1.53 / (download) - annotate - [select for diffs], Mon Aug 6 20:13:47 2018 UTC (5 years, 8 months ago) by adam
Branch: MAIN
Changes since 1.52: +2 -2
lines
Diff to previous 1.52 (colored) to selected 1.73 (colored)
py-sphinx: do not depend on py-sphinx-rtd-theme, but the other way around
Revision 1.52 / (download) - annotate - [select for diffs], Thu Jul 19 09:07:52 2018 UTC (5 years, 9 months ago) by adam
Branch: MAIN
Changes since 1.51: +2 -2
lines
Diff to previous 1.51 (colored) to selected 1.73 (colored)
py-sphinx: 1.7.6
Release 1.7.6:
Bugs fixed
* LaTeX \sphinxupquote{} breaks in Russian
* sphinx.testing uses deprecated pytest API; Node.get_marker(name)
* crashed when recommonmark.AutoStrictify is enabled
* latex: crashed with docutils package provided by Debian/Ubuntu
* latex: a label for table is vanished if table does not have a caption
* crashed with numbered toctree
* C, render empty argument lists for macros.
* C++, fix lookup of full template specializations with no template arguments.
* C++, fix assertion on missing references in global scope when using
intersphinx. Thanks to Alan M. Carroll.
* autodoc: crashed by Form Feed Character
* autodoc: loses the first staticmethod parameter for old styled classes
* quickstart: Typing Ctrl-U clears the whole of line
* html: "relations" sidebar is not shown by default
* latex: curly braces in index entries are not handled correctly
* epub: Wrong internal href fragment links
* apidoc: Interface of sphinx.apidoc:main() has changed
* PDF builds of French projects have issues with XeTeX
* napoleon raises RuntimeError with python 3.7
* sphinx-build: Interface of sphinx:main() has changed
* sphinx-build: sphinx.cmd.build.main() refers sys.argv instead of given
argument
* autosummary: warning is emitted when the first line of docstring ends
with literal notation
* autosummary: warnings of autosummary indicates wrong location
* autodoc: crashed on inspecting dict like object which does not support
sorting
* autodoc: Enum argument missing if it shares value with another
* py domain: rtype field could not handle "None" as a type
* LaTeX: indexing of terms containing @, !, or " fails
* html: crashes if copying static files are failed
* autodoc: Fix formatting type annotations for tuples with more than two
arguments
* i18n: crashed by auto-symbol footnote references
* autosummary: module summary has been broken when it starts with heading
Revision 1.51 / (download) - annotate - [select for diffs], Tue May 29 07:13:07 2018 UTC (5 years, 10 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2018Q2-base,
pkgsrc-2018Q2
Changes since 1.50: +2 -2
lines
Diff to previous 1.50 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.7.5 Release 1.7.5: Bugs fixed * html search: Upper characters problem in any other languages * apidoc: some subpackage is ignored if sibling subpackage contains a module starting with underscore * i18n doesnãàÑÕ handle node.title correctly tat used for contents, topic, admonition, table and section. * i18n: literal blocks in bullet list are not translated * C++, raised TypeError on duplicate declaration. * C++, properly parse expr roles and give better error messages when (escaped) line breaks are present. * C++, properly use desc_addname nodes for prefixes of names. * C++, parse pack expansions in function calls. * * links on search page are broken when using dirhtml builder * autodoc: constructor method should not have return annotation * latex: deeply nested enumerated list which is beginning with non-1 causes LaTeX engine crashed * latex: shorthandoff is not set up for Brazil locale * i18n: Ignore dot-directories like .git/ in LC_MESSAGES/ * py domain: type field could not handle ãàׯoneãàas a type * latex: Incorrect escaping of curly braces in index entries * autodoc: Failed to extract document from a subclass of the class on mocked module * latex: glossary directive adds whitespace to each item * latex: Explicit labels on code blocks are duplicated * node.asdom() crashes if toctree has :numbered: option * autodoc: Parsing error when using dataclasses without default values * autodoc: crashed when handler for autodoc-skip-member raises an error * autodoc: crashed when subclass of mocked class are processed by napoleon module * sphinx-build crashes when error log contains a ãàãàcharacter
Revision 1.50 / (download) - annotate - [select for diffs], Thu Apr 26 07:49:29 2018 UTC (5 years, 11 months ago) by adam
Branch: MAIN
Changes since 1.49: +2 -2
lines
Diff to previous 1.49 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.7.4 Release 1.7.4: Bugs fixed * domains: Crashed with duplicated objects * latex: sphinx.writers.latex causes recusrive import
Revision 1.49 / (download) - annotate - [select for diffs], Wed Apr 25 08:08:21 2018 UTC (5 years, 11 months ago) by adam
Branch: MAIN
Changes since 1.48: +2 -2
lines
Diff to previous 1.48 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.7.3 1.7.3: Bugs fixed * autodoc loses the first staticmethod parameter * autosummary: too wide two column tables in PDF builds * Latex customization via _templates/longtable.tex_t is broken * imgconverter: confused by convert.exe of Windows * On windows, Sphinx crashed when drives of srcdir and outdir are different * autodoc ignores type annotated variables * wrong URLs on warning messages * latex: latex_show_urls assigns incorrect footnote numbers if hyperlinks exists inside substitutions * latex with class memoir Error: Font command \sf is not supported * latex: too slow in proportion to number of auto numbered footnotes * htmlhelp: The entries in .hhp file is not ordered * toctree directive tries to glob for URL having query_string * html search: Upper characters problem in German * latex: Compilation for German docs failed with LuaLaTeX and XeLaTeX * duplicated labels detector does not work well in parallel build * Crashed with extension which returns invalid metadata
Revision 1.48 / (download) - annotate - [select for diffs], Fri Mar 23 07:42:07 2018 UTC (6 years ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2018Q1-base,
pkgsrc-2018Q1
Changes since 1.47: +6 -6
lines
Diff to previous 1.47 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.7.2 Release 1.7.2: Incompatible changes * apidoc: folders with an empty __init__.py are no longer excluded from TOC Bugs fixed * sphinx.build_main and sphinx.make_main throw NameError * autosummary emits meaningless warnings * autodoc: crashed when invalid options given * pydomain: always strip parenthesis if empty * autosummary: unexpectedly strips docstrings containing ãà×Ê.e.ãà* viewcode: Misplaced <div> in viewcode html output * DonãàÑÕ require numfig to use :numref: on sections * Option clash for package textcomp * Sphinx does not work with python 3.5.0 and 3.5.1 * Generation PDF file with TexLive on Windows, file not found error * vertical space before equation in latex * message when an image is mismatched for builder is not clear * Incomplete localization strings in Polish and Chinese * Sphinx crashes when error is happens in rendering HTML pages * Error to download remote images having long URL * sphinx/pycode/__init__.py raises AttributeError * qthelp builder should htmlescape keywords * epub: Fix docTitle elements of toc.ncx is not escaped * apidoc: Subpackage not in toc (introduced in 1.6.6) now fixed
Revision 1.47 / (download) - annotate - [select for diffs], Sun Feb 25 21:39:21 2018 UTC (6 years, 1 month ago) by adam
Branch: MAIN
Changes since 1.46: +7 -6
lines
Diff to previous 1.46 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.7.1 Release 1.7.1: Deprecated 4623: sphinx.build_main() is deprecated. Use sphinx.cmd.build.build_main() instead. autosummary: The interface of sphinx.ext.autosummary.get_documenter() has been changed (Since 1.7.0) 4664: sphinx.ext.intersphinx.debug() is deprecated. Use sphinx.ext.intersphinx.inspect_main() instead. Bugs fixed 4608: epub: Invalid meta tag is generated 4260: autodoc: keyword only argument separator is not disappeared if it is appeared at top of the argument list 4622: epub: epub_scheme does not effect to content.opf 4627: graphviz: Fit graphviz images to page 4617: quickstart: PROJECT_DIR argument is required 4623: sphinx.build_main no longer exists in 1.7.0 4615: The argument of sphinx.build has been changed in 1.7.0 autosummary: The interface of sphinx.ext.autosummary.get_documenter() has been changed 4630: Have order on msgids in sphinx.pot deterministic 4563: autosummary: Incorrect end of line punctuation detection 4577: Enumerated sublists with explicit start with wrong number 4641: A external link in TOC cannot contain ãàãàwith :glob: option C++, add missing parsing of explicit casts and typeid in expression parsing. C++, add missing parsing of this in expression parsing. 4655: Fix incomplete localization strings in Polish 4653: Fix error reporting for parameterless ImportErrors 4664: Reading objects.inv fails again 4662: any refs with term targets crash when an ambiguity is encountered
Revision 1.46 / (download) - annotate - [select for diffs], Mon Feb 5 13:10:59 2018 UTC (6 years, 2 months ago) by adam
Branch: MAIN
Changes since 1.45: +2 -2
lines
Diff to previous 1.45 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.6.7 Release 1.6.7: Bugs fixed ---------- * 1922: html search: Upper characters problem in French * 4412: Updated jQuery version from 3.1.0 to 3.2.1 * 4438: math: math with labels with whitespace cause html error * 2437: make full reference for classes, aliased with "alias of" * 4434: pure numbers as link targets produce warning * 4477: Build fails after building specific files * 4449: apidoc: include "empty" packages that contain modules * 3917: citation labels are tranformed to ellipsis * 4501: graphviz: epub3 validation error caused if graph is not clickable * 4514: graphviz: workaround for wrong map ID which graphviz generates * 4525: autosectionlabel does not support parallel build * 3953: Do not raise warning when there is a working intersphinx inventory * 4487: math: ValueError is raised on parallel build. Thanks to jschueller. * 2372: autosummary: invalid signatures are shown for type annotated functions * 3942: html: table is not aligned to center even if :align: center
Revision 1.45 / (download) - annotate - [select for diffs], Tue Jan 9 20:05:45 2018 UTC (6 years, 3 months ago) by adam
Branch: MAIN
Changes since 1.44: +8 -8
lines
Diff to previous 1.44 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.6.6 Release 1.6.6: Features added * autodoc: Sort dictionary keys when possible * VerbatimHighlightColor is a new :ref:LaTeX 'sphinxsetup' <latexsphinxsetup> key * Easier customizability of LaTeX macros involved in rendering of code-blocks * Show traceback if conf.py raises an exception * Add :confval:smartquotes to disable smart quotes through conf.py * Add :confval:smartquotes_action and :confval:smartquotes_excludes Bugs fixed * sphinx-apidoc: Don't generate references to non-existing files in TOC * latex: reST label between paragraphs loses paragraph break * html: Apply fixFirefoxAnchorBug only under Firefox * napoleon depends on autodoc, but users need to load it manually * automodule fails to document a class attribute * C++: properly link class reference to class from inside constructor * PDF build broken by Unicode U+2116 NUMERO SIGN character * PDF output: Pygments error highlighting increases line spacing in code blocks * Support :emphasize-lines: in PDF output * Sphinx crashes with pickling error when run with multiple processes and remote image * Respect the quiet flag in sphinx-quickstart * Race conditions when creating output directory * For PDF 'howto' documents, latex_toplevel_sectioning='part' generates \chapter commands * Two todolist directives break sphinx-1.6.5 * Fix links to external option docs with intersphinx * Private members not documented without :undoc-members:
Revision 1.44 / (download) - annotate - [select for diffs], Thu Nov 16 07:46:12 2017 UTC (6 years, 5 months ago) by wiz
Branch: MAIN
CVS Tags: pkgsrc-2017Q4-base,
pkgsrc-2017Q4
Changes since 1.43: +2 -2
lines
Diff to previous 1.43 (colored) to selected 1.73 (colored)
py-sphinx: remove py-typing dependency for py35 python-3.5 includes this module.
Revision 1.43 / (download) - annotate - [select for diffs], Tue Oct 24 07:42:12 2017 UTC (6 years, 5 months ago) by adam
Branch: MAIN
Changes since 1.42: +2 -2
lines
Diff to previous 1.42 (colored) to selected 1.73 (colored)
py-sphinx: updated to 1.6.5 Release 1.6.5: Features added * 4107: Make searchtools.js compatible with pre-Sphinx1.5 templates * 4112: Don't override the smart_quotes setting if it was already set * 4125: Display reference texts of original and translated passages on i18n warning message * 4147: Include the exception when logging PO/MO file read/write Bugs fixed * 4085: Failed PDF build from image in parsed-literal using ``:align:`` option * 4100: Remove debug print from autodoc extension * 3987: Changing theme from alabaster causes HTML build to fail * 4096: C++, don't crash when using the wrong role type. Thanks to mitya57. * 4070, 4111: crashes when the warning message contains format strings (again) * 4108: Search word highlighting breaks SVG images * 3692: Unable to build HTML if writing .buildinfo failed * 4152: HTML writer crashes if a field list is placed on top of the document * 4063: Sphinx crashes when labeling directive ``.. todolist::`` * 4134: [doc] :file:`docutils.conf` is not documented explicitly * 4169: Chinese language doesn't trigger Chinese search automatically * 1020: ext.todo todolist not linking to the page in pdflatex * 3965: New quickstart generates wrong SPHINXBUILD in Makefile * 3739: ``:module:`` option is ignored at content of pyobjects * 4149: Documentation: Help choosing :confval:`latex_engine` * 4090: [doc] :confval:`latex_additional_files` with extra LaTeX macros should not use ``.tex`` extension * Failed to convert reST parser error to warning
Revision 1.42 / (download) - annotate - [select for diffs], Thu Sep 28 11:18:24 2017 UTC (6 years, 6 months ago) by adam
Branch: MAIN
Changes since 1.41: +7 -7
lines
Diff to previous 1.41 (colored) to selected 1.73 (colored)
py-sphinx: update to 1.6.4 Release 1.6.4: Features added * 3926: Add autodoc_warningiserror to suppress the behavior of -W option during importing target modules on autodoc Bugs fixed * 3924: docname lost after dynamically parsing RST in extension * 3946: Typo in sphinx.sty (this was a bug with no effect in default context) * pep: and :rfc: does not supports default-role directive (refs: 3960) * 3960: default_role = ãàÏÈuilabelãànot functioning * Missing texinputs_win/Makefile to be used in latexpdf builder on windows. * 4026: nature: Fix macOS Safari scrollbar color * 3877: Fix for C++ multiline signatures. * 4006: Fix crash on parallel build * 3969: private instance attributes causes AttributeError * 4041: C++, remove extra name linking in function pointers. * 4038: C, add missing documentation of member role. * 4044: An empty multicolumn cell causes extra row height in PDF output * 4049: Fix typo in output of sphinx-build -h * 4062: hashlib.sha1() must take bytes, not unicode on Python 3 * Avoid indent after index entries in latex (refs: 4066) * 4070: crashes when the warning message contains format strings * 4067: Return non-zero exit status when make subprocess fails * 4055: graphviz: the :align: option does not work for SVG output * 4055: graphviz: the :align: center option does not work for latex output * 4051: warn() function for HTML theme outputs ãàϯoneãàstring
Revision 1.41 / (download) - annotate - [select for diffs], Sat Aug 19 13:58:00 2017 UTC (6 years, 8 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2017Q3-base,
pkgsrc-2017Q3
Changes since 1.40: +6 -1
lines
Diff to previous 1.40 (colored) to selected 1.73 (colored)
Depend on py-typing only for Python < 3.6
Revision 1.40 / (download) - annotate - [select for diffs], Mon Jul 3 17:43:36 2017 UTC (6 years, 9 months ago) by adam
Branch: MAIN
Changes since 1.39: +6 -4
lines
Diff to previous 1.39 (colored) to selected 1.73 (colored)
Release 1.6.3: Features added -------------- * latex: hint that code-block continues on next page Bugs fixed ---------- * Failed to import sphinx.util.compat with docutils-0.14rc1 * sphinx-quickstart template is incomplete regarding use of alabaster * 'str object' has no attribute 'filename' * Emit wrong warnings if citation label includes hyphens * Some warnings are not colored when using --color option * Remove unwanted whitespace in default template * sphinx.ext.imgmath fails to convert SVG images if project directory name contains spaces * Fix color handling in make mode's help command * use of self.env.warn in sphinx extension fails * production lists apply smart quotes transform since Sphinx 1.6.1 * latex: fix ``\sphinxbfcode`` swallows initial space of argument * Quotes in auto-documented class attributes should be straight quotes in PDF output * LaTeX figure floated to next page sometimes leaves extra vertical whitespace * duplicated footnotes raises IndexError * Failure of deprecation warning mechanism of ``sphinx.util.compat.Directive`` * Bogus warnings for "citation not referenced" for cross-file citations * Don't download images when builders not supported images * Remote image URIs without filename break builders not supported remote images * command line messages are translated unintentionally with ``language`` setting. * make checking ``epub_uid`` strict * Fix about box drawing characters for PDF output * autosummary could not find methods * Emit error if ``latex_documents`` contains non-unicode string in py2
Revision 1.39 / (download) - annotate - [select for diffs], Mon May 29 16:00:27 2017 UTC (6 years, 10 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2017Q2-base,
pkgsrc-2017Q2
Changes since 1.38: +2 -2
lines
Diff to previous 1.38 (colored) to selected 1.73 (colored)
Release 1.6.2: Incompatible changes * 3789: Do not require typing module for python>=3.5 Bugs fixed * 3754: HTML builder crashes if HTML theme appends own stylesheets * 3756: epub: Entity ãàÏÎdashãànot defined * 3758: Sphinx crashed if logs are emitted in conf.py * 3755: incorrectly warns about dedent with literalinclude * 3742: RTD PDF builds of Sphinx own docs are missing an index entry in the bookmarks and table of contents. This is rtfd/readthedocs.org-2857 issue, a workaround is obtained using some extra LaTeX code in SphinxãàÑÔ own conf.py * 3770: Build fails when a ãà×Äode-blockãàhas the option emphasize-lines and the number indicated is higher than the number of lines * 3774: Incremental HTML building broken when using citations * 3772: ãàÏÔtr objectãàhas no attribute ãàÏÇilenameãà* 3763: got epubcheck validations error if epub_cover is set * 3779: ãàϪmportErrorãàin sphinx.ext.autodoc due to broken ãàÏÔys.meta_pathãà Thanks to Tatiana Tereshchenko. * 3796: env.resolve_references() crashes when non-document node given * 3803: Sphinx crashes with invalid PO files * 3791: PDF ãà×Äontinued on next pageãàfor long tables isnãàÑÕ internationalized * 3788: smartquotes emits warnings for unsupported languages * 3807: latex Makefile for make latexpdf is only for unixen * 3781: double hyphens in option directive are compiled as endashes * 3817: latex builder raises AttributeError
Revision 1.38 / (download) - annotate - [select for diffs], Thu May 18 20:09:05 2017 UTC (6 years, 11 months ago) by adam
Branch: MAIN
Changes since 1.37: +5 -5
lines
Diff to previous 1.37 (colored) to selected 1.73 (colored)
Release 1.6.1 (released May 16, 2017) ===================================== Dependencies ------------ 1.6b1 * (updated) latex output is tested with Ubuntu trusty's texlive packages (Feb. 2014) and earlier tex installations may not be fully compliant, particularly regarding Unicode engines xelatex and lualatex * (added) latexmk is required for ``make latexpdf`` on Unix-like platforms Incompatible changes -------------------- 1.6b1 * 1061, 2336, 3235: Now generation of autosummary doesn't contain imported members by default. Thanks to Luc Saffre. * LaTeX ``\includegraphics`` command isn't overloaded: only ``\sphinxincludegraphics`` has the custom code to fit image to available width if oversized. * The subclasses of ``sphinx.domains.Index`` should override ``generate()`` method. The default implementation raises NotImplementedError * LaTeX positioned long tables horizontally centered, and short ones flushed left (no text flow around table.) The position now defaults to center in both cases, and it will obey Docutils 0.13 ``:align:`` option (refs 3415, 3377) * option directive also allows all punctuations for the option name (refs: 3366) * 3413: if :rst:dir:`literalinclude`'s ``:start-after:`` is used, make ``:lines:`` relative (refs 3412) * ``literalinclude`` directive does not allow the combination of ``:diff:`` option and other options (refs: 3416) * LuaLaTeX engine uses ``fontspec`` like XeLaTeX. It is advised ``latex_engine = 'lualatex'`` be used only on up-to-date TeX installs (refs 3070, 3466) * :confval:`latex_keep_old_macro_names` default value has been changed from ``True`` to ``False``. This means that some LaTeX macros for styling are by default defined only with ``\sphinx..`` prefixed names. (refs: 3429) * Footer "Continued on next page" of LaTeX longtable's now not framed (refs: 3497) * 3529: The arguments of ``BuildEnvironment.__init__`` is changed * 3082: Use latexmk for pdf (and dvi) targets (Unix-like platforms only) * 3558: Emit warnings if footnotes and citations are not referenced. The warnings can be suppressed by ``suppress_warnings``. * latex made available (non documented) colour macros from a file distributed with pdftex engine for Plain TeX. This is removed in order to provide better support for multiple TeX engines. Only interface from ``color`` or ``xcolor`` packages should be used by extensions of Sphinx latex writer.
Revision 1.37 / (download) - annotate - [select for diffs], Thu Apr 6 08:51:43 2017 UTC (7 years ago) by adam
Branch: MAIN
Changes since 1.36: +3 -3
lines
Diff to previous 1.36 (colored) to selected 1.73 (colored)
Release 1.5.5 Bugs fixed * 3597: python domain raises UnboundLocalError if invalid name given * 3599: Move to new Mathjax CDN
Revision 1.36 / (download) - annotate - [select for diffs], Tue Jan 3 13:23:04 2017 UTC (7 years, 3 months ago) by jperkin
Branch: MAIN
CVS Tags: pkgsrc-2017Q1-base,
pkgsrc-2017Q1
Changes since 1.35: +5 -5
lines
Diff to previous 1.35 (colored) to selected 1.73 (colored)
Use "${MV} || ${TRUE}" and "${RM} -f" consistently in post-install targets.
Revision 1.35 / (download) - annotate - [select for diffs], Fri Dec 16 20:05:58 2016 UTC (7 years, 4 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2016Q4-base,
pkgsrc-2016Q4
Changes since 1.34: +4 -1
lines
Diff to previous 1.34 (colored) to selected 1.73 (colored)
Remove .pyc file after extraction
Revision 1.34 / (download) - annotate - [select for diffs], Thu Dec 15 11:04:10 2016 UTC (7 years, 4 months ago) by adam
Branch: MAIN
Changes since 1.33: +2 -1
lines
Diff to previous 1.33 (colored) to selected 1.73 (colored)
Added py-requests to DEPENDS
Revision 1.33 / (download) - annotate - [select for diffs], Thu Dec 15 10:48:17 2016 UTC (7 years, 4 months ago) by adam
Branch: MAIN
Changes since 1.32: +2 -2
lines
Diff to previous 1.32 (colored) to selected 1.73 (colored)
Release 1.5.1 (released Dec 13, 2016) ===================================== Features added -------------- * 3214: Allow to suppress "unknown mimetype" warnings from epub builder using :confval:`suppress_warnings`. Bugs fixed ---------- * 3195: Can not build in parallel * 3198: AttributeError is raised when toctree has 'self' * 3211: Remove untranslated sphinx locale catalogs (it was covered by untranslated it_IT) * 3212: HTML Builders crashes with docutils-0.13 * 3207: more latex problems with references inside parsed-literal directive (``\DUrole``) * 3205: sphinx.util.requests crashes with old pyOpenSSL (< 0.14) * 3220: KeyError when having a duplicate citation * 3200: LaTeX: xref inside desc_name not allowed * 3228: ``build_sphinx`` command crashes when missing dependency * 2469: Ignore updates of catalog files for gettext builder. Thanks to Hiroshi Ohkubo. * 3183: Randomized jump box order in generated index page.
Revision 1.32 / (download) - annotate - [select for diffs], Sun Aug 28 15:48:35 2016 UTC (7 years, 7 months ago) by wiz
Branch: MAIN
CVS Tags: pkgsrc-2016Q3-base,
pkgsrc-2016Q3
Changes since 1.31: +1 -3
lines
Diff to previous 1.31 (colored) to selected 1.73 (colored)
Remove unnecessary PLIST_SUBST and FILES_SUBST that are now provided by the infrastructure. Mark a couple more packages as not ready for python-3.x.
Revision 1.31 / (download) - annotate - [select for diffs], Wed Jun 8 17:43:40 2016 UTC (7 years, 10 months ago) by wiz
Branch: MAIN
CVS Tags: pkgsrc-2016Q2-base,
pkgsrc-2016Q2
Changes since 1.30: +2 -2
lines
Diff to previous 1.30 (colored) to selected 1.73 (colored)
Switch to MASTER_SITES_PYPI.
Revision 1.30 / (download) - annotate - [select for diffs], Sat Apr 23 17:48:55 2016 UTC (7 years, 11 months ago) by adam
Branch: MAIN
Changes since 1.29: +5 -5
lines
Diff to previous 1.29 (colored) to selected 1.73 (colored)
Release 1.4.1: 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. Translations ------------ * 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. Bugs fixed ---------- * C++, added support for ``extern`` and ``thread_local``. * C++, type declarations are now using the prefixes ``typedef``, ``using``, and ``type``, depending on the style of declaration. * 2413: C++, fix crash on duplicate declarations * 2394: Sphinx crashes when html_last_updated_fmt is invalid * 2408: dummy builder not available in Makefile and make.bat * 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.
Revision 1.29 / (download) - annotate - [select for diffs], Tue Apr 5 05:38:43 2016 UTC (8 years ago) by khorben
Branch: MAIN
CVS Tags: pkgsrc-2016Q1-base,
pkgsrc-2016Q1
Changes since 1.28: +2 -2
lines
Diff to previous 1.28 (colored) to selected 1.73 (colored)
Apply patch #2247 from upstream This helps generating documentation with textprox/py-sphinx, therefore fixing the build process of some packages using it. Bump PKGREVISION. Approved by pkgsrc-pmc@ during freeze.
Revision 1.28 / (download) - annotate - [select for diffs], Sun Jan 17 13:47:01 2016 UTC (8 years, 3 months ago) by wiz
Branch: MAIN
Changes since 1.27: +13 -5
lines
Diff to previous 1.27 (colored) to selected 1.73 (colored)
Add missing dependencies. Enable test target. All tests now pass for me (python-3.5, NetBSD-7.99.25/amd64).
Revision 1.27 / (download) - annotate - [select for diffs], Fri Jan 15 14:24:41 2016 UTC (8 years, 3 months ago) by darcy
Branch: MAIN
Changes since 1.26: +2 -3
lines
Diff to previous 1.26 (colored) to selected 1.73 (colored)
Upgrade to version 1.3.4. OK'd by maintainer markd@.
Revision 1.26 / (download) - annotate - [select for diffs], Tue Feb 24 11:07:55 2015 UTC (9 years, 1 month ago) by markd
Branch: MAIN
CVS Tags: pkgsrc-2015Q4-base,
pkgsrc-2015Q4,
pkgsrc-2015Q3-base,
pkgsrc-2015Q3,
pkgsrc-2015Q2-base,
pkgsrc-2015Q2,
pkgsrc-2015Q1-base,
pkgsrc-2015Q1
Changes since 1.25: +10 -1
lines
Diff to previous 1.25 (colored) to selected 1.73 (colored)
Use ALTERNATIVES framework to allow concurrent installation under multiple pythons. Bump PKGREVISION.
Revision 1.25 / (download) - annotate - [select for diffs], Sun Sep 14 17:55:38 2014 UTC (9 years, 7 months ago) by wiz
Branch: MAIN
CVS Tags: pkgsrc-2014Q4-base,
pkgsrc-2014Q4,
pkgsrc-2014Q3-base,
pkgsrc-2014Q3
Changes since 1.24: +2 -2
lines
Diff to previous 1.24 (colored) to selected 1.73 (colored)
Update to 1.2.3: Release 1.2.3 (released Sep 1, 2014) ==================================== Features added -------------- * #1518: `sphinx-apidoc` command now have 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 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. * PR#270, #1533: Non-ASCII docstring cause UnicodeDecodeError when uses with inheritance-diagram directive. Thanks to WAKAYAMA shirou. * PR#281, PR#282, #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` generate 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.
Revision 1.24 / (download) - annotate - [select for diffs], Sat Mar 22 13:31:15 2014 UTC (10 years ago) by wiz
Branch: MAIN
CVS Tags: pkgsrc-2014Q2-base,
pkgsrc-2014Q2,
pkgsrc-2014Q1-base,
pkgsrc-2014Q1
Changes since 1.23: +2 -2
lines
Diff to previous 1.23 (colored) to selected 1.73 (colored)
Update to 1.2.2. Not a leaf; has ~5 dependencies. However, 1.2.2 fixes a bug that causes PLIST divergence. Requested by Niclas Rosenvik. Release 1.2.2 (released Mar 2, 2014) ==================================== Bugs fixed ---------- * PR#211: When checking for existence of the :confval:`html_logo` file, check the full relative path and not the basename. * PR#212: Fix traceback with autodoc and ``__init__`` methods without docstring. * PR#213: 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 PR#96 that break sphinx.util.docfields.Field.make_field interface/behavior for `item` argument usage. Documentation ------------- * Extended the :ref:`documentation about building extensions <dev-extensions>`.
Revision 1.23 / (download) - annotate - [select for diffs], Mon Jan 27 19:14:26 2014 UTC (10 years, 2 months ago) by wiz
Branch: MAIN
Changes since 1.22: +2 -2
lines
Diff to previous 1.22 (colored) to selected 1.73 (colored)
Update to 1.2.1:
Release 1.2.1 (released Jan 19, 2014)
=====================================
Bugs fixed
----------
* #1335: Fix autosummary template overloading with exclamation prefix like
``{% extends "!autosummary/class.rst" %}`` cause infinite recursive function
call. This was caused by PR#181.
* #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 :confval:`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
:confval:`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 :rst:dir:`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 :confval:`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 :confval:`exclude_patterns` behavior with subdirectories in the
:confval:`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`)
Revision 1.22 / (download) - annotate - [select for diffs], Sat Jan 25 10:30:25 2014 UTC (10 years, 2 months ago) by wiz
Branch: MAIN
Changes since 1.21: +1 -2
lines
Diff to previous 1.21 (colored) to selected 1.73 (colored)
Mark packages as not ready for python-3.x where applicable; either because they themselves are not ready or because a dependency isn't. This is annotated by PYTHON_VERSIONS_INCOMPATIBLE= 33 # not yet ported as of x.y.z or PYTHON_VERSIONS_INCOMPATIBLE= 33 # py-foo, py-bar respectively, please use the same style for other packages, and check during updates. Use versioned_dependencies.mk where applicable. Use REPLACE_PYTHON instead of handcoded alternatives, where applicable. Reorder Makefile sections into standard order, where applicable. Remove PYTHON_VERSIONS_INCLUDE_3X lines since that will be default with the next commit. Whitespace cleanups and other nits corrected, where necessary.
Revision 1.21 / (download) - annotate - [select for diffs], Thu Jan 2 17:58:22 2014 UTC (10 years, 3 months ago) by wiz
Branch: MAIN
Changes since 1.20: +2 -3
lines
Diff to previous 1.20 (colored) to selected 1.73 (colored)
Update to 1.2:
Release 1.2 (released Dec 10, 2013)
===================================
Features added
--------------
* Added ``sphinx.version_info`` tuple for programmatic checking of the Sphinx
version.
Incompatible changes
--------------------
* Removed the ``sphinx.ext.refcounting`` extension -- it is very specific to
CPython and has no place in the main distribution.
Bugs fixed
----------
* Restore ``versionmodified`` CSS class for versionadded/changed and deprecated
directives.
* Fix: `html_theme_path=['.']` is a trigger of rebuild all documents always
(This change keeps the current "theme changes cause a rebuild" feature).
* #1296: Fix invalid charset in HTML help generated HTML files for default
locale.
* PR#190: Fix gettext does not extract figure caption and rubric title inside
other blocks. Thanks to Michael Schlenker.
* PR#176: Make sure setup_command test can always import Sphinx. Thanks to
Dmitry Shachnev.
* #1311: Fix test_linkcode.test_html fails with C locale and Python 3.
* #1269: Fix ResourceWarnings with Python 3.2 or later.
* #1138: Fix: When ``autodoc_docstring_signature = True`` and
``autoclass_content = 'init'`` or ``'both'``, __init__ line should be
removed from class documentation.
Release 1.2 beta3 (released Oct 3, 2013)
========================================
Features added
--------------
* The Sphinx error log files will now include a list of the loaded extensions
for help in debugging.
Incompatible changes
--------------------
* 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.
Bugs fixed
----------
* #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.
* #703: When Sphinx can't decode filenames with non-ASCII characters, Sphinx now
catches UnicodeError and will continue if possible instead of raising the
exception.
Release 1.2 beta2 (released Sep 17, 2013)
=========================================
Features added
--------------
* ``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.
* Builders: rebuild i18n target document when catalog updated.
* Support docutils.conf 'writers' and 'html4css1 writer' section in the HTML
writer. The latex, manpage and texinfo writers also support their respective
'writers' sections.
* The new :confval:`html_extra_path` config value allows to specify directories
with files that should be copied directly to the HTML output directory.
* 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.
* PR#136: Autodoc directives now support an ``imported-members`` option to
include members imported from different modules.
* New locales: Macedonian, Sinhala, Indonesian.
* Theme package collection by using setuptools plugin mechanism.
Incompatible changes
--------------------
* PR#144, #1182: Force timezone offset to LocalTimeZone on POT-Creation-Date
that was generated by gettext builder. Thanks to masklinn and Jakub Wilk.
Bugs fixed
----------
* PR#132: Updated jQuery version to 1.8.3.
* PR#141, #982: Avoid crash when writing PNG file using Python 3. Thanks to
Marcin Wojdyr.
* PR#145: In parallel builds, sphinx drops second document file to write.
Thanks to tychoish.
* 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.
* Fix: 'make gettext' caused UnicodeDecodeError when templates contain utf-8
encoded strings.
* #828: use inspect.getfullargspec() to be able to document functions with
keyword-only arguments on Python 3.
* #1090: Fix i18n: multiple cross references (term, ref, doc) in the same line
return the same link.
* #1157: Combination of 'globaltoc.html' and hidden toctree caused exception.
* #1159: fix wrong generation of objects inventory for Python modules, and
add a workaround in intersphinx to fix handling of affected inventories.
* #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.
* #1185: Don't crash when a Python module has a wrong or no encoding declared,
and non-ASCII characters are included.
* #1188: sphinx-quickstart raises UnicodeEncodeError if "Project version"
includes non-ASCII characters.
* #1189: "Title underline is too short" WARNING is given when using fullwidth
characters to "Project name" on quickstart.
* #1190: Output TeX/texinfo/man filename has no basename (only extension)
when using non-ASCII characters in the "Project name" on quickstart.
* #1192: Fix escaping problem for hyperlinks in the manpage writer.
* #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.
* PR#146,#1172: Fix ZeroDivisionError in parallel builds. Thanks to tychoish.
* #1204: Fix wrong generation of links to local intersphinx targets.
* #1206: Fix i18n: gettext did not translate admonition directive's title.
* #1232: Sphinx generated broken ePub files on Windows.
* #1259: Guard the debug output call when emitting events; to prevent the
repr() implementation of arbitrary objects causing build failures.
* #1142: Fix NFC/NFD normalizing problem of rst filename on Mac OS X.
* #1234: Ignoring the string consists only of white-space characters.
Release 1.2 beta1 (released Mar 31, 2013)
=========================================
Incompatible changes
--------------------
* Removed ``sphinx.util.compat.directive_dwim()`` and
``sphinx.roles.xfileref_role()`` which were deprecated since version 1.0.
* PR#122: the files given in :confval:`latex_additional_files` now override TeX
files included by Sphinx, such as ``sphinx.sty``.
* PR#124: the node generated by :rst:dir:`versionadded`,
:rst:dir:`versionchanged` and :rst:dir:`deprecated` directives now includes
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.
Features added
--------------
* Markup
- 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.
* HTML builder
- #783: Create a link to full size image if it is scaled with width or height.
- #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.
* 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.
- #1110: A new configuration value :confval:`texinfo_no_detailmenu` has been
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.
* LaTeX builder:
- PR#115: Add ``'transition'`` item in :confval:`latex_elements` for
customizing how transitions are displayed. Thanks to Jeff Klukas.
- PR#114: The LaTeX writer now includes the "cmap" package by default. The
``'cmappkg'`` item in :confval:`latex_elements` can be used to control this.
Thanks to Dmitry Shachnev.
- The ``'fontpkg'`` item in :confval:`latex_elements` now defaults to ``''``
when the :confval:`language` uses the Cyrillic script. Suggested by Dmitry
Shachnev.
- The :confval:`latex_documents`, :confval:`texinfo_documents`, and
:confval:`man_pages` configuration values will be set to default values based
on the :confval:`master_doc` if not explicitly set in :file:`conf.py`.
Previously, if these values were not set, no output would be genereted by
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``.
* 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.
- PR#123, #1106: Add :confval:`epub_use_index` configuration value. If
provided, it will be used instead of :confval:`html_use_index` for epub
builder.
- PR#126: Add :confval:`epub_tocscope` configuration value. The setting
controls the generation of the epub toc. The user can now also include
hidden toc entries.
- PR#112: Add :confval:`epub_show_urls` configuration value.
* 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.
- #869: sphinx-build now has the option :option:`-T` for printing the full
traceback after an unhandled exception.
- sphinx-build now supports the standard :option:`--help` and
:option:`--version` options.
- sphinx-build now provides more specific error messages when called with
invalid options or arguments.
- sphinx-build now has a verbose option :option:`-v` which can be repeated for
greater effect. A single occurrance provides a slightly more verbose output
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.
- PR#108: Add experimental support for parallel building with a new
:option:`-j` option.
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
dangling paragraphs. Fix wrong html output (nested ``<p>`` tag). Fix
versionmodified is not translatable. Thanks to Nozomu Kaneko.
* 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.
* Fix leading space in LaTeX table header cells.
* #1132: Fix LaTeX table output for multi-row cells in the first column.
* #1128: Fix Unicode errors when trying to format time strings with a
non-standard locale.
* #1127: Fix traceback when autodoc tries to tokenize a non-Python file.
* #1126: Fix double-hyphen to en-dash conversion in wrong places such as
command-line option names in LaTeX.
* #1123: Allow whitespaces in filenames given to :rst:dir:`literalinclude`.
* #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.
* #1117: Handle .pyx files in sphinx-apidoc.
* #1112: Avoid duplicate download files when referenced from documents in
different ways (absolute/relative).
* #1111: Fix failure to find uppercase words in search when
:confval:`html_search_language` is 'ja'. Thanks to Tomo Saito.
* #1108: The text writer now correctly numbers enumerated lists with
non-default start values (based on patch by Ewan Edwards).
* #1102: Support multi-context "with" statements in autodoc.
* #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.
* #995: Fix table-of-contents and page numbering for the LaTeX "howto" class.
* #976: Fix gettext does not extract index entries.
* PR#72: #975: Fix gettext not extracting definition terms before docutils 0.10.
* #961: Fix LaTeX output for triple quotes in code snippets.
* #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.
* #723: Fix the search function on local files in WebKit based browsers.
* #440: Fix coarse timestamp resolution in some filesystem generating a wrong
list of outdated files.
Revision 1.20 / (download) - annotate - [select for diffs], Wed May 22 14:31:14 2013 UTC (10 years, 10 months ago) by joerg
Branch: MAIN
CVS Tags: pkgsrc-2013Q4-base,
pkgsrc-2013Q4,
pkgsrc-2013Q3-base,
pkgsrc-2013Q3,
pkgsrc-2013Q2-base,
pkgsrc-2013Q2
Changes since 1.19: +2 -1
lines
Diff to previous 1.19 (colored) to selected 1.73 (colored)
Revert, py-jinja2 has to adjust.
Revision 1.19 / (download) - annotate - [select for diffs], Wed May 22 14:28:57 2013 UTC (10 years, 10 months ago) by joerg
Branch: MAIN
Changes since 1.18: +1 -3
lines
Diff to previous 1.18 (colored) to selected 1.73 (colored)
No Python 3 support for py-jinja2.
Revision 1.18 / (download) - annotate - [select for diffs], Thu Oct 25 06:56:52 2012 UTC (11 years, 5 months ago) by asau
Branch: MAIN
CVS Tags: pkgsrc-2013Q1-base,
pkgsrc-2013Q1,
pkgsrc-2012Q4-base,
pkgsrc-2012Q4
Changes since 1.17: +1 -3
lines
Diff to previous 1.17 (colored) to selected 1.73 (colored)
Drop superfluous PKG_DESTDIR_SUPPORT, "user-destdir" is default these days.
Revision 1.17 / (download) - annotate - [select for diffs], Wed Oct 17 22:14:44 2012 UTC (11 years, 6 months ago) by wiz
Branch: MAIN
Changes since 1.16: +7 -1
lines
Diff to previous 1.16 (colored) to selected 1.73 (colored)
Use REPLACE_PYTHON to fix /usr/bin/env usage. Allow python-3.x. Bump PKGREVISION.
Revision 1.16 / (download) - annotate - [select for diffs], Mon Apr 23 16:53:12 2012 UTC (11 years, 11 months ago) by drochner
Branch: MAIN
CVS Tags: pkgsrc-2012Q3-base,
pkgsrc-2012Q3,
pkgsrc-2012Q2-base,
pkgsrc-2012Q2
Changes since 1.15: +6 -1
lines
Diff to previous 1.15 (colored) to selected 1.73 (colored)
give hints for selftest
Revision 1.15 / (download) - annotate - [select for diffs], Mon Apr 23 14:52:53 2012 UTC (11 years, 11 months ago) by adam
Branch: MAIN
Changes since 1.14: +2 -2
lines
Diff to previous 1.14 (colored) to selected 1.73 (colored)
Changes 1.1.3: * 40: Fix ``safe_repr`` function to decode bytestrings with non-ASCII characters correctly. * 37: Allow configuring sphinx-apidoc via ``SPHINX_APIDOC_OPTIONS``. * 34: Restore Python 2.4 compatibility. * 36: Make the "bibliography to TOC" fix in LaTeX output specific to the document class. * 695: When the highlight language "python" is specified explicitly, do not try to parse the code to recognize non-Python snippets. * 859: Fix exception under certain circumstances when not finding appropriate objects to link to. * 860: Do not crash when encountering invalid doctest examples, just emit a warning. * 864: Fix crash with some settings of :confval:`modindex_common_prefix`. * 862: Fix handling of ``-D`` and ``-A`` options on Python 3. * 851: Recognize and warn about circular toctrees, instead of running into recursion errors. * 853: Restore compatibility with docutils trunk. * 852: Fix HtmlHelp index entry links again. * 854: Fix inheritance_diagram raising attribute errors on builtins. * 832: Fix crashes when putting comments or lone terms in a glossary. * 834, 818: Fix HTML help language/encoding mapping for all Sphinx supported languages. * 844: Fix crashes when dealing with Unicode output in doctest extension. * 831: Provide ``--project`` flag in setup_command as advertised. * 875: Fix reading config files under Python 3. * 876: Fix quickstart test under Python 3. * 870: Fix spurious KeyErrors when removing documents. * 892: Fix single-HTML builder misbehaving with the master document in a subdirectory. * 873: Fix assertion errors with empty ``only`` directives. * 816: Fix encoding issues in the Qt help builder.
Revision 1.14 / (download) - annotate - [select for diffs], Sun Apr 8 19:09:14 2012 UTC (12 years ago) by wiz
Branch: MAIN
Changes since 1.13: +1 -3
lines
Diff to previous 1.13 (colored) to selected 1.73 (colored)
Remove python24 and all traces of it from pkgsrc. Remove devel/py-ctypes (only needed by and supporting python24). Remove PYTHON_VERSIONS_ACCEPTED and PYTHON_VERSIONS_INCOMPATIBLE lines that just mirror defaults now. Miscellaneous cleanup while editing all these files.
Revision 1.13 / (download) - annotate - [select for diffs], Sat Feb 4 12:42:09 2012 UTC (12 years, 2 months ago) by obache
Branch: MAIN
CVS Tags: pkgsrc-2012Q1-base,
pkgsrc-2012Q1
Changes since 1.12: +3 -1
lines
Diff to previous 1.12 (colored) to selected 1.73 (colored)
No compiler is requilred.
Revision 1.12 / (download) - annotate - [select for diffs], Mon Dec 5 15:34:12 2011 UTC (12 years, 4 months ago) by dholland
Branch: MAIN
CVS Tags: pkgsrc-2011Q4-base,
pkgsrc-2011Q4
Changes since 1.11: +3 -1
lines
Diff to previous 1.11 (colored) to selected 1.73 (colored)
Uses perl-type if syntax and thus does not work with python24.
Revision 1.11 / (download) - annotate - [select for diffs], Mon Nov 28 10:48:25 2011 UTC (12 years, 4 months ago) by adam
Branch: MAIN
Changes since 1.10: +2 -2
lines
Diff to previous 1.10 (colored) to selected 1.73 (colored)
Changes 1.1.2: * 809: Include custom fixers in the source distribution. Changes 1.1.1: * 791: Fix QtHelp, DevHelp and HtmlHelp index entry links. * 792: Include "sphinx-apidoc" in the source distribution. * 797: Don't crash on a misformatted glossary. * 801: Make intersphinx work properly without SSL support. * 805: Make the ``Sphinx.add_index_to_domain`` method work correctly. * 780: Fix Python 2.5 compatibility.
Revision 1.10 / (download) - annotate - [select for diffs], Wed Oct 5 07:53:27 2011 UTC (12 years, 6 months ago) by obache
Branch: MAIN
Changes since 1.9: +3 -3
lines
Diff to previous 1.9 (colored) to selected 1.73 (colored)
Update py-sphinx to 1.0.8. While here, * fixes egg-info `requires' information for python>2.6, with bump dependency on py-docutils with egg-info. Release 1.0.8 (Sep 23, 2011) ============================ * #627: Fix tracebacks for AttributeErrors in autosummary generation. * Fix the ``abbr`` role when the abbreviation has newlines in it. * #727: Fix the links to search results with custom object types. * #648: Fix line numbers reported in warnings about undefined references. * #696, #666: Fix C++ array definitions and template arguments that are not type names. * #633: Allow footnotes in section headers in LaTeX output. * #616: Allow keywords to be linked via intersphinx. * #613: Allow Unicode characters in production list token names. * #720: Add dummy visitors for graphviz nodes for text and man. * #704: Fix image file duplication bug. * #677: Fix parsing of multiple signatures in C++ domain. * #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. * #657: viewcode now works correctly with source files that have non-ASCII encoding. * #669: Respect the ``noindex`` flag option in py:module directives. * #675: Fix IndexErrors when including nonexisting lines with :rst:dir:`literalinclude`. * #676: Respect custom function/method parameter separator strings. * #682: Fix JS incompatibility with jQuery >= 1.5. * #693: Fix double encoding done when writing HTMLHelp .hhk files. * #647: Do not apply SmartyPants in parsed-literal blocks. * C++ domain now supports array definitions.
Revision 1.9 / (download) - annotate - [select for diffs], Wed Mar 23 11:41:49 2011 UTC (13 years ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2011Q3-base,
pkgsrc-2011Q3,
pkgsrc-2011Q2-base,
pkgsrc-2011Q2,
pkgsrc-2011Q1-base,
pkgsrc-2011Q1
Changes since 1.8: +2 -2
lines
Diff to previous 1.8 (colored) to selected 1.73 (colored)
Changes 1.0.7: * Fix wrong generation of directives of static methods in autosummary. * Import PIL as ``from PIL import Image``. * Fix longtables with captions in LaTeX output. * Make token references work as hyperlinks again in LaTeX output. * Show warnings by default when reference labels cannot be found. * Include line number when complaining about missing reference targets in nitpicky mode. * Fix inline display of graphviz diagrams in LaTeX output. * Build using app.build() in setup command. * Fix a bug in the inheritance diagram exception that caused base classes to be skipped if one of them is a builtin. * Fix general index links for C++ domain objects. * Make admonition boundaries in LaTeX output visible. * Fix KeyErrors occurring on rebuild after removing a file. * Fix a traceback when removing files with globbed toctrees. * 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. * Fix a bug where the removal of download files and images wasn't noticed. * Implement ``~`` cross-reference prefix for the C domain. * Fix regression of LaTeX output. * Fix lookup of class attribute documentation on descriptors so that comment documentation now works. * Fix traceback with ``only`` directives preceded by targets. * Fix tracebacks occurring for duplicate C++ domain objects. * Fix JavaScript domain links to objects with ``$`` in their name.
Revision 1.8 / (download) - annotate - [select for diffs], Mon Oct 18 12:54:59 2010 UTC (13 years, 6 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2010Q4-base,
pkgsrc-2010Q4
Changes since 1.7: +2 -3
lines
Diff to previous 1.7 (colored) to selected 1.73 (colored)
Changes 1.0.4: * Open intersphinx inventories in binary mode on Windows, since version 2 contains zlib-compressed data. * Allow giving non-local URIs for JavaScript files, e.g. in the JSMath extension. * Fix traceback when ``intersphinx_mapping`` is empty. Changes 1.0.3: * Fix internal vs. external link distinction for links coming from a docutils table-of-contents. * Fix the ``maxdepth`` option for the ``toctree()`` template callable when used with ``collapse=True``. * Fix crash parsing Python argument lists containing brackets in string literals. * Fix regression when building LaTeX docs with figures that don't have captions. * Fix inheritance diagrams for classes that are not picklable. * Introduce separate background color for the sidebar collapse button, making it easier to see. * Fix small layout bugs in several builtin themes.
Revision 1.7 / (download) - annotate - [select for diffs], Mon Sep 27 10:29:22 2010 UTC (13 years, 6 months ago) by adam
Branch: MAIN
CVS Tags: pkgsrc-2010Q3-base,
pkgsrc-2010Q3
Changes since 1.6: +2 -2
lines
Diff to previous 1.6 (colored) to selected 1.73 (colored)
PLIST fix
Revision 1.6 / (download) - annotate - [select for diffs], Sun Aug 22 21:03:24 2010 UTC (13 years, 7 months ago) by markd
Branch: MAIN
Changes since 1.5: +4 -4
lines
Diff to previous 1.5 (colored) to selected 1.73 (colored)
Update py-sphinx to 1.0.1
* Support for domains has been added. A domain is a collection of
directives and roles that all describe objects belonging together,
e.g. elements of a programming language. A few builtin domains are
provided:
- Python
- C
- C++
- JavaScript
- reStructuredText
* 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.
* 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
references. It is activated by the :option:`-n` command-line switch
or the :confval:`nitpicky` config value.
- Added ``latexpdf`` target in quickstart Makefile.
* Markup:
- The :rst:role:`menuselection` and :rst:role:`guilabel` roles now
support ampersand accelerators.
- New more compact doc field syntax is now recognized: ``:param type
name: description``.
- Added ``tab-width`` option to :rst:dir:`literalinclude` directive.
- Added ``titlesonly`` option to :rst:dir:`toctree` directive.
- Added the ``prepend`` and ``append`` options to the
:rst:dir:`literalinclude` directive.
- #284: All docinfo metadata is now put into the document metadata, not
just the author.
- The :rst:role:`ref` role can now also reference tables by caption.
- The :rst:dir:`include` directive now supports absolute paths, which
are interpreted as relative to the source directory.
- In the Python domain, references like ``:func:`.name``` now look for
matching names with any prefix if no direct match is found.
* New builders:
- Added a builder for the Epub format.
- Added a builder for manual pages.
- Added a single-file HTML builder.
* Extensions:
- Added the :mod:`~sphinx.ext.viewcode` extension.
- Added the :mod:`~sphinx.ext.extlinks` extension.
- Added support for source ordering of members in autodoc, with
``autodoc_member_order = 'bysource'``.
- Added :confval:`autodoc_default_flags` config value, which can be
used to select default flags for all autodoc directives.
- 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.
- 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
:confval:`graphviz_output_format` config value.
- Added ``alt`` option to :rst:dir:`graphviz` extension directives.
- Added ``exclude`` argument to :func:`.autodoc.between`.
Revision 1.5 / (download) - annotate - [select for diffs], Tue Jun 1 21:22:10 2010 UTC (13 years, 10 months ago) by markd
Branch: MAIN
CVS Tags: pkgsrc-2010Q2-base,
pkgsrc-2010Q2
Changes since 1.4: +2 -2
lines
Diff to previous 1.4 (colored) to selected 1.73 (colored)
Update to Sphinx-0.6.6 many bug fixes.
Revision 1.4 / (download) - annotate - [select for diffs], Wed Aug 5 10:43:12 2009 UTC (14 years, 8 months ago) by markd
Branch: MAIN
CVS Tags: pkgsrc-2010Q1-base,
pkgsrc-2010Q1,
pkgsrc-2009Q4-base,
pkgsrc-2009Q4,
pkgsrc-2009Q3-base,
pkgsrc-2009Q3
Changes since 1.3: +2 -1
lines
Diff to previous 1.3 (colored) to selected 1.73 (colored)
add LICENSE
Revision 1.3 / (download) - annotate - [select for diffs], Wed Aug 5 10:41:17 2009 UTC (14 years, 8 months ago) by markd
Branch: MAIN
Changes since 1.2: +3 -4
lines
Diff to previous 1.2 (colored) to selected 1.73 (colored)
Update to sphinx 0.6.2
* Incompatible changes:
- Templating now requires the Jinja2 library
- The "document" div tag has been moved out of the ``layout.html``
template's "document" block
- The ``autodoc_skip_member`` event now also gets to decide
whether to skip members whose name starts with underscores.
* Theming support
* 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.
- 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".
- Added HTML section numbers, enabled by giving a
``:numbered:`` flag to the ``toctree`` directive.
- Scaled images now get a link to the unscaled version.
- SVG images are now supported in HTML (via ``<object>`` and
``<embed>`` tags).
* Builders:
- 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``.
* New translations:
* Bug Fixes.
Revision 1.2 / (download) - annotate - [select for diffs], Mon Feb 2 09:44:44 2009 UTC (15 years, 2 months ago) by markd
Branch: MAIN
CVS Tags: pkgsrc-2009Q2-base,
pkgsrc-2009Q2,
pkgsrc-2009Q1-base,
pkgsrc-2009Q1
Changes since 1.1: +3 -1
lines
Diff to previous 1.1 (colored) to selected 1.73 (colored)
Note py-jinja dependency. pkgsrc's docutils doesn't install an egg-info so dont note the requirement in this egg-info as it wont be detected. Bump PKGREVISION.
Revision 1.1.1.1 / (download) - annotate - [select for diffs] (vendor branch), Sat Jan 31 05:31:13 2009 UTC (15 years, 2 months ago) by markd
Branch: TNF
CVS Tags: pkgsrc-base
Changes since 1.1: +0 -0
lines
Diff to previous 1.1 (colored) to selected 1.73 (colored)
Import py-sphinx 0.5.1 Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils. Although it is still under constant development, the following features are already present, work fine and can be seen "in action" in the Python docs: * Output formats: HTML (including Windows HTML Help), plain text and LaTeX, for printable PDF versions * Extensive cross-references: semantic markup and automatic links for functions, classes, glossary terms and similar pieces of information * Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children * Automatic indices: general index as well as a module index * Code handling: automatic highlighting using the Pygments highlighter * Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings.
Revision 1.1 / (download) - annotate - [select for diffs], Sat Jan 31 05:31:13 2009 UTC (15 years, 2 months ago) by markd
Branch: MAIN
Diff to selected 1.73 (colored)
Initial revision