Code Monkey home page Code Monkey logo

irods_docs's Introduction

iRODS Documentation

Build Status

The iRODS documentation is housed in this repository (https://github.com/irods/irods_docs).

Each release is kept in a separate branch.

Prerequisites

  • git, g++, flex, bison, cmake, python, virtualenv, mkdocs
  • iCommands (the version the generated docs will reflect)

Update for correct version

  • Update Makefile with correct MAKEIRODSVERSION
  • Update irods_for_doxygen/Doxyfile with correct PROJECT_NUMBER

Build

The Makefile default target will build two other targets, 'doxygen' and 'mkdocs'.

$ make

The resulting site directory will contain the generated standalone documentation.

irods_docs's People

Contributors

trel avatar alanking avatar korydraughn avatar mcoonen avatar mcast avatar

Watchers

James Cloos 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.