Skip to content

Commit

Permalink
doc: Update readme for release
Browse files Browse the repository at this point in the history
  • Loading branch information
attakei committed May 3, 2024
1 parent 7536cfb commit db50661
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 3 deletions.
39 changes: 39 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
rst-budoux
==========

.. list-table::

* - Badges
- .. image:: https://img.shields.io/pypi/v/rst-budoux.svg
:target: https://pypi.org/project/rst-budoux/
- .. image:: https://github.com/attakei-lab/rst-budoux/actions/workflows/main.yml/badge.svg
:target: https://github.com/attakei-lab/rst-budoux/actions
- .. image:: https://readthedocs.org/projects/rst-budoux/badge/?version=stable
:target: https://rst-budoux.readthedocs.io/en/sable

Text splitter in reStructuredText by BudouX.

.. raw:: html
Expand All @@ -14,9 +24,38 @@ Text splitter in reStructuredText by BudouX.

`日本語での説明があります。 <https://github.com/attakei-lab/rst-budoux/blob/main/README_ja.rst> `_

Overview
========

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

See `document <https://rst-budoux.readthedocs.io/>`_ for more information.

Usage
=====

You can install from PyPI.

.. code:: console
pip install rst-budoux
This provides also as Sphinx-extension, therefore it works to register into your ``conf.py``.

.. code:: python
extensions = [
"rst_budoux.sphinx",
]
You want to use wihout Sphinx ? Please see `document <https://rst-budoux.readthedocs.io/>`_.

Example
=======

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

.. code:: rst
Example from BudouX
Expand Down
3 changes: 0 additions & 3 deletions README_ja.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ docutilsの ``rst2pseudoxml`` を使うと、内部ではこのような構成
使い方
======

.. note:: ここは予定を書いています。

インストール
------------

Expand Down Expand Up @@ -107,7 +105,6 @@ Sphinxを経由しての利用例
"rst_budoux.sphinx",
]
budoux_html_separator = "<wbr>"
buxoux_html_append_style = """
body {
word-break: keep-all;
Expand Down

0 comments on commit db50661

Please sign in to comment.