sphinxcontrib-redoc


Namesphinxcontrib-redoc JSON
Version 1.6.0 PyPI version JSON
download
home_pagehttps://github.com/ikalnytskyi/sphinxcontrib-redoc
SummaryReDoc powered OpenAPI (fka Swagger) spec renderer for Sphinx
upload_time2020-04-17 19:46:48
maintainer
docs_urlNone
authorIhor Kalnytskyi
requires_python
licenseBSD
keywords sphinx openapi swagger rest api renderer docs redoc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            sphinxcontrib-redoc
===================

|pypi-version| |travis-ci|

The Sphinx_ extension that renders OpenAPI_ (fka Swagger) specs with love
(❤️) using amazing ReDoc_. Don't believe it? Here's `the proof`_. Now stop
frustrating and start moving your projects to OpenAPI and ReDoc with this
small first step:

.. code:: bash

    $ pip install sphinxcontrib-redoc

* Free software: BSD License
* Documentation: https://sphinxcontrib-redoc.readthedocs.io
* Source: https://github.com/ikalnytskyi/sphinxcontrib-redoc
* Bugs: https://github.com/ikalnytskyi/sphinxcontrib-redoc/issues

Any feedback, any contribution is really appreciated!


.. _Sphinx: https://www.sphinx-doc.org/
.. _OpenAPI: https://openapis.org/specification
.. _ReDoc: https://github.com/Rebilly/ReDoc
.. _the proof: https://sphinxcontrib-redoc.readthedocs.io/en/latest/api/github/

.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-redoc.svg
   :target: https://pypi.python.org/pypi/sphinxcontrib-redoc

.. |travis-ci| image:: https://img.shields.io/travis/ikalnytskyi/sphinxcontrib-redoc.svg
   :target: https://travis-ci.org/ikalnytskyi/sphinxcontrib-redoc
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ikalnytskyi/sphinxcontrib-redoc",
    "name": "sphinxcontrib-redoc",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "sphinx openapi swagger rest api renderer docs redoc",
    "author": "Ihor Kalnytskyi",
    "author_email": "ihor@kalnytskyi.com",
    "download_url": "https://files.pythonhosted.org/packages/6d/73/872189269380d0271d575771986db8a77f06bc4565c1a971bebd54f38d2c/sphinxcontrib-redoc-1.6.0.tar.gz",
    "platform": "",
    "description": "sphinxcontrib-redoc\n===================\n\n|pypi-version| |travis-ci|\n\nThe Sphinx_ extension that renders OpenAPI_ (fka Swagger) specs with love\n(\u2764\ufe0f) using amazing ReDoc_. Don't believe it? Here's `the proof`_. Now stop\nfrustrating and start moving your projects to OpenAPI and ReDoc with this\nsmall first step:\n\n.. code:: bash\n\n    $ pip install sphinxcontrib-redoc\n\n* Free software: BSD License\n* Documentation: https://sphinxcontrib-redoc.readthedocs.io\n* Source: https://github.com/ikalnytskyi/sphinxcontrib-redoc\n* Bugs: https://github.com/ikalnytskyi/sphinxcontrib-redoc/issues\n\nAny feedback, any contribution is really appreciated!\n\n\n.. _Sphinx: https://www.sphinx-doc.org/\n.. _OpenAPI: https://openapis.org/specification\n.. _ReDoc: https://github.com/Rebilly/ReDoc\n.. _the proof: https://sphinxcontrib-redoc.readthedocs.io/en/latest/api/github/\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-redoc.svg\n   :target: https://pypi.python.org/pypi/sphinxcontrib-redoc\n\n.. |travis-ci| image:: https://img.shields.io/travis/ikalnytskyi/sphinxcontrib-redoc.svg\n   :target: https://travis-ci.org/ikalnytskyi/sphinxcontrib-redoc",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "ReDoc powered OpenAPI (fka Swagger) spec renderer for Sphinx",
    "version": "1.6.0",
    "project_urls": {
        "Homepage": "https://github.com/ikalnytskyi/sphinxcontrib-redoc"
    },
    "split_keywords": [
        "sphinx",
        "openapi",
        "swagger",
        "rest",
        "api",
        "renderer",
        "docs",
        "redoc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d73872189269380d0271d575771986db8a77f06bc4565c1a971bebd54f38d2c",
                "md5": "9018e23d2cde1048a3dff723ba78c076",
                "sha256": "e358edbe23927d36432dde748e978cf897283a331a03e93d3ef02e348dee4561"
            },
            "downloads": -1,
            "filename": "sphinxcontrib-redoc-1.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9018e23d2cde1048a3dff723ba78c076",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 350482,
            "upload_time": "2020-04-17T19:46:48",
            "upload_time_iso_8601": "2020-04-17T19:46:48.041926Z",
            "url": "https://files.pythonhosted.org/packages/6d/73/872189269380d0271d575771986db8a77f06bc4565c1a971bebd54f38d2c/sphinxcontrib-redoc-1.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-04-17 19:46:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ikalnytskyi",
    "github_project": "sphinxcontrib-redoc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "sphinxcontrib-redoc"
}
        
Elapsed time: 0.20774s