Skip to main content

Overview

This is Sphinx extension to break line of heading texts by BudouX.

Simple example

From source is:

あなたに寄り添う最先端のテクノロジー
====================================

Output without this is:

<h1>あなたに寄り添う最先端のテクノロジー</h1>

Output with this is:

<h1 style="word-break: keep-all; overflow-wrap: break-word;">あなたに<wbr/>寄り添う<wbr/>最先端の<wbr/>テクノロジー</h1>

Installation

pip install sphinxcontrib-budoux

Usage

extensions = [
    "sphinxcontrib.budoux",
]

# Tag to ijnect for splitted texts
budoux_split_tag = "wbr"
# Style for splitted-tag
budoux_split_style = "budoux_split_style", "word-break: keep-all; overflow-wrap: break-word;"
# Target tags for apply BudouX
budoux_targets = ["h1", "h2"]

Note

Main targets for edit are heading text, not but contents of paragraph.

If you set p, li and others into budoux_targets`, this may not work correctly that you think.

Example

See doc (written by Japanese).

Metadata

Release files for sphinxcontrib-budoux 0.1.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxcontrib-budoux 0.1.6
File Size Uploaded Provenance
sphinxcontrib_budoux-0.1.6.tar.gz 6.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib-budoux 0.1.6
File Interpreter ABI Platform
sphinxcontrib_budoux-0.1.6-py3-none-any.whl Python 3 none any Details

Total release size: 13.1 kB

Release files / sphinxcontrib_budoux-0.1.6.tar.gz

Download URL sphinxcontrib_budoux-0.1.6.tar.gz
Size 6.3 kB
Tags Source
SHA-256 checksum
How to use checksums
530c0942e0d42b783953a3f41c6fd808cd282389ff3977791f65596be978ee86
BLAKE2b-256 checksum
How to use checksums
2c054555ac1200141da49dc0e7b1cc0fe117851f4de6866064aafa940f11d2a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / sphinxcontrib_budoux-0.1.6-py3-none-any.whl

Download URL sphinxcontrib_budoux-0.1.6-py3-none-any.whl
Size 6.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d16eb8a32937cb0d0c69bcab82ae89c4f19824ae424825ee51c700815f34cf6b
BLAKE2b-256 checksum
How to use checksums
4d9e83dfefc20e396f4f2a8b8d0ad4e2dfbc11b800a8e8d9ba7e94054ad228c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Security for sphinxcontrib-budoux 0.1.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page