summaryrefslogtreecommitdiff
path: root/scripts/build_docs.sh
blob: 4837587ad308a371c9841ad2b8ebae2b8da6d714 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/bin/bash
# Build documentation for display in web browser.

PORT=${1:-4000}

echo "usage: build_docs.sh [port]"

# Find the docs dir, no matter where the script is called
ROOT_DIR="$( cd "$(dirname "$0")"/.. ; pwd -P )"
cd $ROOT_DIR

# Gather docs.
scripts/gather_examples.sh

# Split caffe.proto for inclusion by layer catalogue.
scripts/split_caffe_proto.py

# Generate developer docs.
make docs

# Display docs using web server.
cd docs
jekyll serve -w -s . -d _site --port=$PORT