{
"info": {
"author": "",
"author_email": "",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Framework :: Sphinx :: Extension",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Documentation :: Sphinx",
"Topic :: Software Development :: Documentation",
"Topic :: Text Processing :: Markup",
"Typing :: Typed"
],
"description": "\nSphinx reStructuredText Builder\n*******************************\n\n`Sphinx `_ extension to build reST (`reStructuredText `_) files.\n\nThis extension is in particular useful to use in combination with the autodoc\nextension to automatically generate documentation for use by any rst parser\n(such as the GitHub wiki).\n\nIn itself, the extension is fairly straightforward \u2013 it takes the parsed reST\nfile from `Sphinx `_ and outputs it as reST.\n\n\nRequirements\n============\n\n* `Sphinx `_ 2.0 or later\n\n* Python 3.6 or later\n\n\nInstalling\n==========\n\n\nUsing pip\n---------\n\n..\n\n pip install sphinx-rst-builder\n\n\nManual\n------\n\n..\n\n git clone `https://github.com/davidfritzsche/sphinx-rst-builder.git `_\n cd sphinx-rst-builder\n python setup.py install\n\nIf you want to take a look and have a try, you can put the reST builder in\nan extension subdirectory, and adjust ``sys.path`` to tell Sphinx where to\nlook for it:\n\n* Add the extensions directory to the path in ``conf.py``. E.g.\n\n ..\n sys.path.append(os.path.abspath(\u2018exts\u2019))\n\n\nUsage\n=====\n\n* Set the builder as a extension in ``conf.py``:\n\n ..\n extensions = [\u2018sphinx_rst_builder\u2019]\n\n* Run sphinx-build with target ``rst``:\n\n ..\n sphinx-build -b rst -c . build/rst\n\n\nConfiguration\n=============\n\nThe following four configuration variables are defined by sphinxcontrib.restbuilder:\n\n``rst_file_suffix``\n\n This is the file name suffix for generated reST files. The default is\n ``\".rst\"``.\n\n``rst_link_suffix``\n\n Suffix for generated links to reST files. The default is whatever\n ``rst_file_suffix`` is set to.\n\n``rst_file_transform``\n\n Function to translate a docname to a filename.\n By default, returns *docname* + ``rst_file_suffix``.\n\n``rst_link_transform``\n\n Function to translate a docname to a (partial) URI.\n By default, returns *docname* + ``rst_link_suffix``.\n\n\nFurther Reading\n===============\n\n* `Sphinx `_\n\n* `reStructuredText `_\n\n\nFeedback\n========\n\nThe reST builder is in a preliminary state. It\u2019s not (yet) widely used, so\nany feedback is particularly welcome.\n\n\nChangelog\n*********\n\n\nsphinx-rst-builder 0.0.1 (21 June 2019)\n=======================================\n\n* Renamed from sphinxcontrib.restbuilder to sphinx-rst-builder\n\n* Code location: `https://github.com/davidfritzsche/sphinx-rst-builder `_\n\n\nrestbuilder 0.2 (7 June 2018)\n=============================\n\n* Code moved to `https://gitub.com/sphinx-contrib/restbuilder `_\n\n* Python 3 compatible (Nicola Musatti)\n\n* Adhere to rst_indent-specified indentation (Matthew Planchard)\n\n* Fixed issue where links were converted to plaintext (Matthew Planchard)\n\n\nrestbuilder 0.1 (25 August 2013)\n================================\n\n* Code submitted to sphinx-contrib\n `https://bitbucket.org/birkenfeld/sphinx-contrib `_\n\n* Released as sphinxcontrib-restbuilder\n\n* Added basic documentation\n\n* Unsupported/unknown tags are not printed, but send to log facility.\n\n\nrestbuilder (no version) (28 April 2012)\n========================================\n\n* First release as port of a documentation generator in the NBT package\n `https://github.com/twoolie/NBT/commit/eefbd26c422a0e5f3c89e84fabcfb951a11722b0 `_\n\nBSD-2-Clause License\n====================\n\nCopyright (c) 2019 by David Fritzsche and contributors.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n* Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\nLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\nDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\nTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\nContributors\n============\n\nFreek Dijkstra (macfreek)\nG. Nicholas d'Andrea (gnidan)\nJeffrey Lo (jeffrey_lo)\nMatthew Planchard (mplanchard)\nNicola Musatti (nmusatti)\nDavid Fritzsche (davidfritzsche)\n\n\n",
"description_content_type": "text/x-rst",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/davidfritzsche/sphinx-rst-builder",
"keywords": "",
"license": "BSD-2-Clause",
"maintainer": "David Fritzsche",
"maintainer_email": "david.fritzsche@mvua.de",
"name": "sphinx-rst-builder",
"package_url": "https://pypi.org/project/sphinx-rst-builder/",
"platform": "any",
"project_url": "https://pypi.org/project/sphinx-rst-builder/",
"project_urls": {
"Homepage": "https://github.com/davidfritzsche/sphinx-rst-builder"
},
"release_url": "https://pypi.org/project/sphinx-rst-builder/0.0.1/",
"requires_dist": [
"sphinx (>=2)"
],
"requires_python": ">=3.6",
"summary": "Sphinx reStructuredText builder",
"version": "0.0.1"
},
"last_serial": 5431518,
"releases": {
"0.0.1": [
{
"comment_text": "",
"digests": {
"md5": "39ed7361fa60d063ea2165a57131e1aa",
"sha256": "98991876fa111cb7732525375c6c5354c0fff8e2ca0b082ac21cff1cb7ddd74a"
},
"downloads": -1,
"filename": "sphinx_rst_builder-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39ed7361fa60d063ea2165a57131e1aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12336,
"upload_time": "2019-06-21T15:42:38",
"url": "https://files.pythonhosted.org/packages/f7/75/06822bf1fc1466d8374ee6713bf8f20fd8a3a84180145efb829bbaec8e29/sphinx_rst_builder-0.0.1-py3-none-any.whl"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "39ed7361fa60d063ea2165a57131e1aa",
"sha256": "98991876fa111cb7732525375c6c5354c0fff8e2ca0b082ac21cff1cb7ddd74a"
},
"downloads": -1,
"filename": "sphinx_rst_builder-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39ed7361fa60d063ea2165a57131e1aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12336,
"upload_time": "2019-06-21T15:42:38",
"url": "https://files.pythonhosted.org/packages/f7/75/06822bf1fc1466d8374ee6713bf8f20fd8a3a84180145efb829bbaec8e29/sphinx_rst_builder-0.0.1-py3-none-any.whl"
}
]
}