Metadata-Version: 1.2
Name: sphinxcontrib-sphinx-rest-api-doc
Version: 0.0.8.dev7
Summary: a tools for sphinx gen doc from rest api
Home-page: http://www.sphinx-doc.org/
Author: yishenggudou
Author-email: yishenggudou@gmail.com
License: BSD 2
Description: =====================================
        sphinxcontrib-sphinx-rest-api-doc
        =====================================
        
        .. image:: https://travis-ci.org/yishenggudou/sphinxcontrib-sphinx-rest-api-doc.svg?branch=master
            :target: https://travis-ci.org/yishenggudou/sphinxcontrib-sphinx-rest-api-doc
        
        a tools for sphinx gen doc from json api
        
        Overview
        --------
        
        Add a longer description here.
        
        INSTALL
        --------------------
        
        .. code-block::bash
        
            pip install sphinxcontrib-sphinx-rest-api-doc
        
        Basic usage
        ----------------------
        .. code-block:: rst
        
           .. rest: path_to_model.json
        
        
        
        CONFIG
        ----------
        
        
        in config.py
        
        .. code-block::py
            
          extensions += ['sphinxcontrib.sphinxcontrib-sphinx-rest-api-doc', ]
          swagger_api_url = os.path.join(PROJECT_DIR, "_static", "api-docs.json")
          swagger_api_domain = "timger.com.cn"
        
        
        
        Links
        -----
        
        - Source: https://github.com/yishenggudou/sphinxcontrib-sphinx-rest-api-doc
        - Bugs: https://github.com/yishenggudou/sphinxcontrib-sphinx-rest-api-doc/issues
        
        
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >3.0
