Skip to content

Releases: doxtr/doxtr-xlink

v2.0.0 - Renamed to doxtr-xlink

Choose a tag to compare

@doxtr doxtr released this 16 Oct 19:45

doxtr-xlink 2.0.0

This release renames the project from sphinxcontrib-xlink to doxtr-xlink, bringing it into the doxtr family of Sphinx extensions. The functionality is unchanged from 1.3.1. This is a packaging and identity change only.

Breaking change: The PyPI package name and the Sphinx extension import name have both changed. Existing installations will not upgrade automatically. See the migration steps below.

Migrating from sphinxcontrib-xlink

  1. Update your install. Replace the old package with the new one:

    pip uninstall sphinxcontrib-xlink
    pip install doxtr-xlink

    Update requirements.txt, pyproject.toml, or other dependency manifests accordingly: sphinxcontrib-xlink becomes doxtr-xlink.

  2. Update your conf.py. Change the extension identifier:

    # Before
    extensions = ['sphinxcontrib.xlink']
    
    # After
    extensions = ['doxtr_xlink']

That is it. No changes are required to your .xlink files, the :xlink: role, the xlink-list / xlink-search directives, any xlink_* configuration options, or the generated HTML/CSS classes. All of these are unchanged.

What changed under the hood

  • The Python package moved from the sphinxcontrib.xlink namespace package to a standalone doxtr_xlink package.
  • The distribution is now published to PyPI as doxtr-xlink.
  • Switched the build backend to Hatchling with single-source versioning (the version is read from doxtr_xlink.__version__).
  • CI/publish workflows updated (actions/checkout bumped to v6).

Unchanged

  • All features, directives, roles, and configuration options.
  • The .xlink file format and VSCode snippet generation.
  • Sphinx-Needs integration, BibTeX (.bib) generation, and the interactive bookmark search.

Full Changelog: v1.3.1...v2.0.0