Giter VIP home page Giter VIP logo

documentation-hydrus's Introduction

documentation-hydrus

This reposity contains documentation of hydrus built using Sphinx

You can check the current documentation here

Steps to build doc

  • Clone this repository.
$ git clone https://github.com/HTTP-APIs/documentation-hydrus.git
  • Clone the hydrus repository.
$ git clone https://github.com/HTTP-APIs/hydrus.git
$ source `which virtualenvwrapper.sh`
$ mkvirtualenv -p python3 hydrus
(hydrus) $ deactivate         # To deactivate the virtual environment
$ workon hydrus               # To activate virtual environment
  • Install requirements
(hydrus)$ cd documentation-hydrus 
(hydrus)$ pip install -r requirements.txt
  • Install hydrus
(hydrus)$ cd hydrus           # Go to your hydrus folder
(hydrus)$ pip install -e .    # To install hydrus
  • Copy the doc folder from documentation-hydrus folder to hydrus folder (Important step).

  • Everything is done now you can build the doc's .

(hydrus)$ cd hydrus/doc                 # The doc folder which was copied from documentation-hydrus to hydrus
(hydrus)$ sphinx-build -b html path/to/hydrus/doc/rst path/to/hydrus/doc/_build/html

Where "path/to/hydrus/doc/rst" and "path/to/hydrus/doc/_build/html" are your local folder path.

  • To make a clean build
(hydrus)$ make clean
(hydrus)$ sphinx-build -b html path/to/hydrus/doc/rst path/to/hydrus/doc/_build/html

documentation-hydrus's People

Contributors

mec-is avatar nityanandagohain avatar sameshl avatar sandeepsajan0 avatar xadahiya avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

documentation-hydrus's Issues

Improve README

README.md should provide information about how the repo has been developed and which design choices have been made.

module not found error

I am trying to build the documentation. This is the error that I am getting.

screenshot from 2018-02-16 15-15-15

I have installed hydrus by cd into hydrus folder and then pip install -e .

Design document on the hydrus workflow

As hydrus define a precise workflow like:

  1. the API designer write a SWAGGER/OpenAPI JSON document that describes his/her API (yet to be implemented, hopefully this year. Please consider submitting an application for this)
  2. hydrus parser will parse this JSON into a HYDRA API documentation (example here)
  3. hydrus deploys the Web server byt parsing the outcome at 2.
  4. hydrus serves the API
  5. HYDRA-aware generic clients can use the API

We need an extensive document that improve the current WIKI by adding a detailed description of this workflow, with references to RDF codebase and Hydra draft.

References:

Move documentation to hydrus

Instead of having separate repos for each project, we should add all documentation in the doc/ path into the hydrus repo. This way we build documentation directly with hydrus.

We should also implement the same things for other repos that need documentation.

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.