/irods_docs

iRODS Documentation

Primary LanguageShell

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.