tripalproject/tripaldoc repository overview

This image is used to build the Tripal Project documentation.

⁠Usage

The following commands get you ready to start editing and building the Tripal Project documentation. Essentially they pull down the git repository locally and get a copy of this docker image.

git clone https://github.com/tripal/tripal_doc
cd tripal_doc
docker pull tripalproject/tripaldoc:latest

Then use the following command to build the documentation. This command creates a docker container, builds the documentation in your local tripal_doc folder and then removes the container.

docker run --rm --volume=`pwd`:/tripal_doc tripaldocs:latest make html

Then once the above completes successfully you should be able to open the local copy of your documentation:

open docs/_build/html/index.html