https://github.com/irods/irods_docs
iRODS Documentation
https://github.com/irods/irods_docs
Last synced: 10 months ago
JSON representation
iRODS Documentation
- Host: GitHub
- URL: https://github.com/irods/irods_docs
- Owner: irods
- Created: 2016-10-22T17:51:59.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2025-05-20T15:41:14.000Z (about 1 year ago)
- Last Synced: 2025-05-20T16:36:51.300Z (about 1 year ago)
- Language: Shell
- Size: 1.96 MB
- Stars: 3
- Watchers: 6
- Forks: 17
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
iRODS Documentation
===================
The iRODS documentation is housed in this repository (https://github.com/irods/irods_docs).
Prerequisites
-------------
- docker
Update for correct version
--------------------------
- Update Makefile with correct GITHUB_ACCOUNT
- Update Makefile with correct GIT_COMMITTISH
Build
-----
Docker will create a builder image.
```
$ docker build -t irods_docs_builder .
```
Running the docker image will save artifacts into `$(pwd)/build`:
```
$ docker run --rm -v $(pwd):/irods_docs:ro -v $(pwd)/build:/hostcomputer irods_docs_builder
```
You can generate documentation for a specific build of iRODS by running the following:
```
$ docker run --rm -v $(pwd):/irods_docs:ro -v $(pwd)/build:/hostcomputer irods_docs_builder GITHUB_ACCOUNT= GIT_COMMITTISH=
```
The resulting `build/site` directory will contain the generated standalone documentation.
View
----
Launch a webserver on port 8080 to show the resulting `build/site` directory:
```bash
$ docker run -d --rm --name irods_docs -p 8080:80 -v $(pwd)/build/site:/usr/local/apache2/htdocs/ httpd:2.4
```
To stop the webserver:
```bash
$ docker stop irods_docs
```