Package: bfabio.sphinx-rst-builder
Sphinx reStructuredText BuilderSphinxextension to build reST (reStructuredText) files.This extension is in particular useful to use in combination with the autodoc
extension to automatically generate documentation for use by any rst parser
(such as the GitHub wiki).In itself, the extension is fairly straightforward – it takes the parsed reST
file fromSphinxand outputs it as reST.RequirementsSphinx2.0 or laterPython 3.6 or laterInstallingUsing pippip install sphinx-rst-builderManualgit clonehttps://github.com/davidfritzsche/sphinx-rst-builder.gitcd sphinx-rst-builder
python setup.py installIf you want to take a look and have a try, you can put the reST builder in
an extension subdirectory, and adjustsys.pathto tell Sphinx where to
look for it:Add the extensions directory to the path inconf.py. E.g.UsageSet the builder as a extension inconf.py:Run sphinx-build with targetrst:ConfigurationThe following four configuration variables are defined by sphinxcontrib.restbuilder:rst_file_suffixThis is the file name suffix for generated reST files.  The default is".rst".rst_link_suffixSuffix for generated links to reST files.  The default is whateverrst_file_suffixis set to.rst_file_transformFunction to translate a docname to a filename.
By default, returnsdocname+rst_file_suffix.rst_link_transformFunction to translate a docname to a (partial) URI.
By default, returnsdocname+rst_link_suffix.Further ReadingSphinxreStructuredTextFeedbackThe reST builder is in a preliminary state. It’s not (yet) widely used, so
any feedback is particularly welcome.Changelogsphinx-rst-builder 0.0.1 (21 June 2019)Renamed from sphinxcontrib.restbuilder to sphinx-rst-builderCode location:https://github.com/davidfritzsche/sphinx-rst-builderrestbuilder 0.2 (7 June 2018)Code moved tohttps://gitub.com/sphinx-contrib/restbuilderPython 3 compatible (Nicola Musatti)Adhere to rst_indent-specified indentation (Matthew Planchard)Fixed issue where links were converted to plaintext (Matthew Planchard)restbuilder 0.1 (25 August 2013)Code submitted to sphinx-contribhttps://bitbucket.org/birkenfeld/sphinx-contribReleased as sphinxcontrib-restbuilderAdded basic documentationUnsupported/unknown tags are not printed, but send to log facility.restbuilder (no version) (28 April 2012)First release as port of a documentation generator in the NBT packagehttps://github.com/twoolie/NBT/commit/eefbd26c422a0e5f3c89e84fabcfb951a11722b0BSD-2-Clause LicenseCopyright (c) 2019 by David Fritzsche and contributors.Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
“AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.ContributorsFreek Dijkstra (macfreek)
G. Nicholas d’Andrea (gnidan)
Jeffrey Lo (jeffrey_lo)
Matthew Planchard (mplanchard)
Nicola Musatti (nmusatti)
David Fritzsche (davidfritzsche)