a tools for sphinx gen doc from rest api
Project 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
example in model file
----------------------
.. literalinclude:: model.test.json
:language: json
CONFIG
----------
in config.py
.. code-block:: py
extensions += ['sphinxcontrib.sphinxcontrib-sphinx-rest-api-doc',]
rest_api_source_root = os.path.join(PROJECT_DIR, "_static", "models")
rest_api_domain = "timger.com.cn"
rest_api_http_request_example_title = "Request Example"
rest_api_http_request_example_title = "Response Example"
Links
-----
- Source: https://github.com/yishenggudou/sphinxcontrib-sphinx-rest-api-doc
- Bugs: https://github.com/yishenggudou/sphinxcontrib-sphinx-rest-api-doc/issues
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
example in model file
----------------------
.. literalinclude:: model.test.json
:language: json
CONFIG
----------
in config.py
.. code-block:: py
extensions += ['sphinxcontrib.sphinxcontrib-sphinx-rest-api-doc',]
rest_api_source_root = os.path.join(PROJECT_DIR, "_static", "models")
rest_api_domain = "timger.com.cn"
rest_api_http_request_example_title = "Request Example"
rest_api_http_request_example_title = "Response Example"
Links
-----
- Source: https://github.com/yishenggudou/sphinxcontrib-sphinx-rest-api-doc
- Bugs: https://github.com/yishenggudou/sphinxcontrib-sphinx-rest-api-doc/issues
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for sphinxcontrib-sphinx-rest-api-doc-0.0.9.dev8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d66491398ce2341ba06e084c67663346430a605a3370bac5aff180e7151fb777 |
|
MD5 | 13c6d7a48e1efe94f8fbb0f961b0ff5b |
|
BLAKE2b-256 | 61cb69c5216c31b35583c1c879926d9372c6f66f4b794a183055e9e3fbed3032 |