2022-10-25 20:36:42 by Adam Ciarcinski | Files touched by this commit (3) | |
Log message:
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.
|
2022-04-15 17:58:35 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
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
|
2022-01-25 10:20:30 by Thomas Klausner | Files touched by this commit (1) | |
Log message:
py-sphinx: restore lower bound now that package is updated
Bump PKGREVISION since it didn't actually run with older versions.
|
2022-01-25 01:26:18 by Thomas Klausner | Files touched by this commit (1) | |
Log message:
py-sphinx: remove lower bound on py-importlib-metadata
pkgsrc version is not new enough; hopefully someone will update it soon
|
2022-01-24 19:21:18 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
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
|
2022-01-05 16:41:32 by Thomas Klausner | Files touched by this commit (289) |
Log message:
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.
|
2022-01-04 21:55:40 by Thomas Klausner | Files touched by this commit (1595) |
Log message:
*: bump PKGREVISION for egg.mk users
They now have a tool dependency on py-setuptools instead of a DEPENDS
|
2021-12-19 17:49:41 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
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.
|
2021-11-28 17:34:50 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
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 “defer” 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 “async” method again
|
2021-11-11 09:59:09 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
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 “defer” 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 “fuzzy” 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 “toctree contains reference to excluded document” \
warnings using suppress_warnings
Bugs fixed
* autodoc: Failed to build cross references if primary_domain is not ‘py’
* 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 “documented” 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 ‘py’
* 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 “aggedright” 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.
|