Skip to main content

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

Project description


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

Simple example

From source is:


Output without this is:


Output with this is:

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


pip install sphinxcontrib-budoux


extensions = [

# 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"]


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.


See doc (written by Japanese).

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

sphinxcontrib-budoux-0.1.5.tar.gz (6.8 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_budoux-0.1.5-py3-none-any.whl (6.8 kB view hashes)

Uploaded Python 3

Supported by

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