build

Building the manuscript

build.sh builds the repository. sh build.sh should be executed from the root directory of the repository.

To build a DOCX file of the manuscript, set the BUILD_DOCX environment variable to true. For example, use the command BUILD_DOCX=true sh build/build.sh. Set a Travis environment variable to export DOCX for all Travis builds. Currently, equation numbers via pandoc-eqnos are not supported for DOCX output. There is varying support for embedding images in DOCX output. Please reference Pull Request #40 for possible solutions and continued discussion.

Environment

Install or update the conda environment specified in environment.yml by running:

# If the manubot environment already exists, remove it first
conda env remove --name manubot

# Install the environment
conda env create --file environment.yml

Activate with conda activate manubot (assumes conda version of at least 4.4). The environment should successfully install on both Linux and macOS (and possibly Windows).