Sphinx Builder Clause Samples
The Sphinx Builder clause establishes the use of the Sphinx documentation generator for creating and maintaining project documentation. It typically specifies that all documentation must be written in reStructuredText and compiled using Sphinx, ensuring consistency in formatting and structure across the project. By mandating a standardized documentation tool, this clause helps streamline collaboration, maintain high-quality documentation, and reduce confusion over documentation formats.
Sphinx Builder. If your Sphinx project is already configured for the LaTeX builder, rinohtype will happily inter- pret latex_documents. Otherwise, you need to set the rinoh_documents configuration option: rinoh_documents = [dict(doc='index', # top-level file (index.rst) target='manual')] # output file (manual.pdf) The dictionary accepts optional keys in addition to the required doc and target keys. See sphinx_builder for details. When building the documentation, select the rinoh builder by passing it to the sphinx-build -b option: sphinx-build -b rinoh . _build/rinoh Note that, just like the rinoh command line tool, the Sphinx builder requires two rendering passes.
Sphinx Builder. Configuring rinohtype as a builder for Sphinx allows rendering a Sphinx project to PDF without the need for a LaTeX installation. The document you are reading was rendered using rino- htype’s Sphinx builder.