Giter VIP home page Giter VIP logo

df_api_doc's Introduction

DataFibers API Document Generation

This is repository for API document generation using APIDOCJS.

Installation

You can install the generator by running one time only.

./install.sh

Generation

You generate the document using below command. The source file will be archived for version control purpose.

./generate.sh

Merge

Once the API document is generated, we can merge it to the resource folder in DataFibers Data Service codebase by running

./merge.sh

Running

To see the live documentation, you can either by running the DF jar application or start standalone web server in the document root.

cd apidoc
python -m SimpleHTTPServer 8000

df_api_doc's People

Contributors

willddy avatar

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.