Skip to content
iRODS Documentation
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
.gitignore
.travis.yml
Makefile
README.md
dynamic_peps.json
generate_dynamic_peps_md.py
generate_icommands_md.sh
mkdocs.yml
requirements.txt

README.md

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.

You can’t perform that action at this time.