Giter VIP home page Giter VIP logo

json-protocol's Introduction

JSON Protocol specs

Documentation Status

Current specs is built on top of Sphinx documentation generator.

Specs are released under the terms of the MIT license.

Read it online!

JSON Protocol specs.

Run it!

You'll have to install Python Sphinx 1.3 minimum.

If your distribution does not provide this version, you could use a virtualenv:

$ virtualenv /path/to/virtualenv/files
$ source /path/to/virtualenv/bin/activate
$ pip install -r requirements.txt

Once all has been successfully installed, just run the following to build the documentation:

$ make html

Results will be avaiable in the build/html directory :)

Note that it actually uses the readthedocs theme installed in your virtual environment and it can differ locally from the one on readthedocs system.

Autobuild

Autobuild automatically rebuild and refresh the current page on edit. To use it, you need the sphinx-autobuild module:

$ pip install sphinx-autobuild

You can then use the sphinx-autobuild command:

$ sphinx-autobuild source build/html

And access your documentation on the proposed link: http://127.0.0.1:8000

json-protocol's People

Contributors

g-bougard avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

c3ph3us

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.