OOD Documentation
- Website: http://openondemand.org/
- Documentation: https://osc.github.io/ood-documentation/master/
- Main code repo: https://github.com/OSC/ondemand
- Core library repo: https://github.com/OSC/ood_core
- Original repo with JOSS publication: https://github.com/OSC/Open-OnDemand
Usage
Go to https://osc.github.io/ood-documentation/master/ to see the latest published release version.
Or select your version:
Development
Open pull requests to the develop branch, which is the main branch of this repo. This repo uses the gitflow branching model.
There are two ways to build the documentation.
- Use the Docker image that is used to build them in production using Travis.
- Use pipenv to install local dependencies.
pipenv
has become the recommended package to use by python.org for dependency management
Docker
Currently all builds are generated using the docker-sphinx Docker image. They are built using the following command from the root of this repo:
docker run --rm -i -t -v "${PWD}:/doc" -u "$(id -u):$(id -g)" ohiosupercomputer/docker-sphinx make html
Or use the rake task added:
rake docker:build
pipenv
If you don't want to use Docker, you can also use pipenv.
-
Ensure plantuml and graphviz are installed:
# on OS X brew install plantuml brew install graphviz
-
Install pipenv and use it to install dependencies in same directory:
pip install -g pipenv # then in the documentation root directory: WORKDIR=/doc PIPENV_VENV_IN_PROJECT=1 pipenv install # or using handy rake task: rake pipenv:install
When building the docs, run this command:
WORKDIR=/doc PIPENV_VENV_IN_PROJECT=1 pipenv run make html
or use the rake task:
rake pipenv:build
# or
rake build
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/OSC/ood-documentation.
License
- Documentation, website content, and logo is licensed under CC-BY-4.0
- Code is licensed under MIT (see LICENSE.txt)