rst-budoux

Badges

https://readthedocs.org/projects/rst-budoux/badge/?version=stable

Text splitter in reStructuredText by BudouX.

https://raw.githubusercontent.com/attakei-lab/rst-budoux/main/mv.png

Overview

This is bridge library to docutils and budoux. You can break lines naturally when build contents from reStructuredText by using this.

See document for more information.

Usage

You can install from PyPI.

pip install rst-budoux

This provides also as Sphinx-extension, therefore it works to register into your conf.py.

extensions = [
    "rst_budoux.sphinx",
]

You want to use wihout Sphinx ? Please see document.

Example

This is example using psuedoxml outputs for “docutils only” and “with rst-budoux”.

Example from BudouX
===================

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

$ run rst2pseudoxml examples/budoux-sample-text.rst
<document ids="example-from-budoux" names="example\ from\ budoux" source="examples/budoux-sample-text.rst" title="Example from BudouX">
    <title>
        Example from BudouX
    <paragraph>
        あなたに寄り添う最先端のテクノロジー。

$ run rst-budoux2pseudoxml examples/budoux-sample-text.rst
<document ids="example-from-budoux" names="example\ from\ budoux" source="examples/budoux-sample-text.rst" title="Example from BudouX">
    <title>
        Example from BudouX
    <paragraph>
        あなたに
        <word-break>
        寄り添う
        <word-break>
        最先端の
        <word-break>
        テクノロジー。

Metadata

Release files for rst-budoux 0.1.1

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

Source distribution (sdist)

Source distribution for rst-budoux 0.1.1
File	Size	Uploaded
rst_budoux-0.1.1.tar.gz	552.4 kB	May 3, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for rst-budoux 0.1.1
File	Interpreter	ABI	Platform	Reset
rst_budoux-0.1.1-py3-none-any.whl 9.9 kB May 3, 2024	Python 3	none	any	Details

Total release size: 562.3 kB

Release files / rst_budoux-0.1.1.tar.gz

Download URL	rst_budoux-0.1.1.tar.gz
Size	552.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`3a773d9201b82b0bdc6c4c93472ed2128d19b0f4a4ae096b32135d365c356e10`
BLAKE2b-256 checksum How to use checksums	`d29f1d919762fab79c5ce409949152451675d7d1bba8d161feea1ccf1754ac74`
Upload date	May 3, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`

Release files / rst_budoux-0.1.1-py3-none-any.whl

Download URL	rst_budoux-0.1.1-py3-none-any.whl
Size	9.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a289cfbd3984e997396b00cc96b70bac99363014ab4e270fcc5c7b4c54ee71ab`
BLAKE2b-256 checksum How to use checksums	`c655707b67e5e109670879b000ee55d5182036f59204a86026df0396e9533a93`
Upload date	May 3, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`