Skip to main content

CLI tool to normalize LaTeX \tag numbering in Jupyter Notebook files

Project description

tagrefsorter

A CLI tool to normalize LaTeX \tag{} numbering in Jupyter Notebook (.ipynb) files.

Installation

pip install tagrefsorter

Usage

tagrefsorter path/to/notebook.ipynb

The notebook is overwritten in place.

Algorithm Overview

tagrefsorter processes LaTeX math blocks in markdown cells of a Jupyter Notebook and normalizes equation numbering based on the following rules:

  • For each display math block written as $$ ... $$, a LaTeX \tag{} is added if missing, or updated if already present, so that equation numbers become sequential.

  • If a display math block contains an align environment,

    $$\begin{align}
    ...
    \end{align}$$
    

    then each line inside the align environment is treated as an individual equation. A \tag{} is added or updated for each line, and equation numbers are assigned sequentially in appearance order.

  • Existing tags of the form \tag{x} are considered author-specified equation identifiers. If a markdown cell contains a reference written as $(x)$, it is interpreted as a reference to \tag{x}. When equation numbers are renumbered, all corresponding $(x)$ references are automatically updated to match the new equation number.

As a result, equation numbering and references remain consistent even after equations are reordered, added, or removed.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tagrefsorter-0.3.1.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tagrefsorter-0.3.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file tagrefsorter-0.3.1.tar.gz.

File metadata

  • Download URL: tagrefsorter-0.3.1.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tagrefsorter-0.3.1.tar.gz
Algorithm Hash digest
SHA256 5b8571ad1f1e0c497332882989735ba3f9c6d3800d6940b7e617d32a0dd53cb6
MD5 a3f5ec80251350f8ee134dd6d77aab76
BLAKE2b-256 eeb759a3076af5cdaf5e19c3878459593bc91a8023dfc8e80858643545e8f29a

See more details on using hashes here.

Provenance

The following attestation bundles were made for tagrefsorter-0.3.1.tar.gz:

Publisher: publish.yml on SuzuSys/TagRefSorter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tagrefsorter-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: tagrefsorter-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tagrefsorter-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7dc992e7973b5c6c8e73a92200c03d3e475fa069aa509b364f06572d1af3d09c
MD5 72add4a541f5e41ecb158d32ce6baace
BLAKE2b-256 8bf44b8e3a411c2b0b2b52b7f8e295452e638f7aef6c05c747a787fe4207763b

See more details on using hashes here.

Provenance

The following attestation bundles were made for tagrefsorter-0.3.1-py3-none-any.whl:

Publisher: publish.yml on SuzuSys/TagRefSorter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page