Text style extension README
This is a sphinx extension to use some text styles.
- Ruby Annotation
Ruby annotation is HTML 5 Ruby tag (http://www.w3.org/TR/ruby/), not ruby computer language.
> pip install sphinxcontrib-textstyle
To enable this extension, add sphinxcontrib.textstyle module to extensions option at conf.py.
# Enabled extensions extensions = ['sphinxcontrib.textstyle']
ruby role makes ruby tag
A first string becomes ruby base (<rb>) and a string which is inside <> becomes ruby text(<rt>). For rubytag not supported browser such as Firefox, ( and ) are used to represent ruby text(<rp>). You can change this character in the conf.py. See below config section.
Del role makes delete (<del>).
Del is also a directive.
.. del:: delete note(not shown) This specification will be deleted
Color role changes the text color by using <span style="color">. Please keep in mind about this may break the separation of content and presentation.
These two variables specify chracters which present ruby text.
rubytag_rp_start = '[' rubytag_rp_end = ']'
The BSD 2-Clause License.