Skip to content

rst_builder.rst

Latest commit

 

History

History
38 lines (26 loc) · 616 Bytes

rst_builder.rst

File metadata and controls

38 lines (26 loc) · 616 Bytes

sphinx_rst_builder

This directive outputs the documentation in :epkg:`RST` format with all the sphinx directives converted into pure RST format.

Usage

In conf.py:

extensions = [ ...
    'sphinx_runpython.sphinx_rst_builder',
]

Classes

RstBuilder

.. autoclass:: sphinx_runpython.sphinx_rst_builder.RstBuilder
    :members:

RstTranslator

.. autoclass:: sphinx_runpython.sphinx_rst_builder.RstTranslator
    :members:

RstWriter

.. autoclass:: sphinx_runpython.sphinx_rst_builder.RstWriter
    :members: