OpenAD Documentation

This repo contains the documentation website for OpenAD, which can be viewed at:
acceleratedscience.github.io/openad-docs

Updating Documentation

Most of the documentation is auto-generated from the README file in the main OpenAD repository:

• commands.md
• installation.md

For instructions on how to regenerate the documentation files, please refer to /docs/generate_docs.py in the OpenAD repo.

Build & Preview Locally

Assuming Jekyll and Bundler are installed on your computer:

1. Change your working directory to the root directory of your site.

2. Run bundle install.

3. Run bundle exec jekyll serve to build your site and preview it at localhost:4000.

   The built site is stored in the directory _site.

Update Live Website

The website is automatically redeployed whenever the main branch is updated.

git add .
git commit -m "Updated documentation"
git push

Tech Stack

The documentation website is built using just-the-docs which runs on Jekyll.
Deployment is managed by GitHub Actions. More information can be found in the just-the-docs README.