=======
rapidoc
=======
.. image:: https://travis-ci.org/sphinx-contrib/rapidoc.svg?branch=master
:target: https://travis-ci.org/sphinx-contrib/rapidoc
RapiDoc powered OpenAPI spec renderer for Sphinx.
Overview
--------
This extension provides RapiDoc powered OpenAPI spec renderer for Sphinx.
Installation
------------
.. code:: bash
$ pip install sphinxcontrib-rapidoc
* Free software: BSD License
* Documentation: TBD
* Source: https://github.com/sphinx-contrib/sphinx-contrib-rapidoc
* Bugs: https://github.com/sphinx-contrib/sphinx-contrib-rapidoc/issues
Have an idea or found something not working, feedback is much appreciated!
.. _Sphinx: https://www.sphinx-doc.org/
.. _OpenAPI: https://openapis.org/specification
.. _RapiDoc: https://github.com/rapi-doc/RapiDoc
=======
License
=======
Copyright (c) 2024 by QO <quiz.oxis@gmail.com>
All rights reserved.
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.
Raw data
{
"_id": null,
"home_page": "http://www.sphinx-doc.org/",
"name": "sphinxcontrib-rapidoc",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "'sphinx openapi swagger rest api renderer docs rapidoc'",
"author": "QO",
"author_email": "quiz.oxis@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/19/3d/efae15108d9af8b6f3a9101fd2ca52865a2e40e8ca0eeb32b84ae8630b2e/sphinxcontrib_rapidoc-0.1.2.tar.gz",
"platform": null,
"description": "=======\nrapidoc\n=======\n\n.. image:: https://travis-ci.org/sphinx-contrib/rapidoc.svg?branch=master\n :target: https://travis-ci.org/sphinx-contrib/rapidoc\n\nRapiDoc powered OpenAPI spec renderer for Sphinx.\n\nOverview\n--------\n\nThis extension provides RapiDoc powered OpenAPI spec renderer for Sphinx.\n\nInstallation\n------------\n\n.. code:: bash\n\n $ pip install sphinxcontrib-rapidoc\n\n* Free software: BSD License\n* Documentation: TBD\n* Source: https://github.com/sphinx-contrib/sphinx-contrib-rapidoc\n* Bugs: https://github.com/sphinx-contrib/sphinx-contrib-rapidoc/issues\n\nHave an idea or found something not working, feedback is much appreciated!\n\n.. _Sphinx: https://www.sphinx-doc.org/\n.. _OpenAPI: https://openapis.org/specification\n.. _RapiDoc: https://github.com/rapi-doc/RapiDoc\n\n=======\nLicense\n=======\n\n\nCopyright (c) 2024 by QO <quiz.oxis@gmail.com>\nAll rights reserved.\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",
"bugtrack_url": null,
"license": null,
"summary": "RapiDoc powered OpenAPI spec renderer for Sphinx.",
"version": "0.1.2",
"project_urls": {
"Homepage": "http://www.sphinx-doc.org/"
},
"split_keywords": [
"'sphinx",
"openapi",
"swagger",
"rest",
"api",
"renderer",
"docs",
"rapidoc'"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "193defae15108d9af8b6f3a9101fd2ca52865a2e40e8ca0eeb32b84ae8630b2e",
"md5": "faf8dd92dc52e8bb7a78cd62e4bdcd5b",
"sha256": "9cad554d81613242f17c24d79b0cc43a0dfaf77b89c8352842f9582561e34ac4"
},
"downloads": -1,
"filename": "sphinxcontrib_rapidoc-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "faf8dd92dc52e8bb7a78cd62e4bdcd5b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 257477,
"upload_time": "2024-12-24T06:11:12",
"upload_time_iso_8601": "2024-12-24T06:11:12.241955Z",
"url": "https://files.pythonhosted.org/packages/19/3d/efae15108d9af8b6f3a9101fd2ca52865a2e40e8ca0eeb32b84ae8630b2e/sphinxcontrib_rapidoc-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-24 06:11:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinxcontrib-rapidoc"
}
JSON