Skip to content

Commit 5f0dc38

Browse files
committed
Docs
1 parent 9c44ba8 commit 5f0dc38

File tree

81 files changed

+116
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+116
-0
lines changed

bin/jvmdocs.sh

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#!/bin/sh
2+
3+
# This script is supposed to run from the directory of the maven project for the docs for and takes 3 arguments:
4+
# 1. The name of the project: e.g. bullet-core
5+
# 2. The tag to build docs for: e.g 1.2.0
6+
# 3. The directory to copy containing the master branch of the bullet-db.github.io git repository
7+
# It will clean and checkout the repo at the tag, build the docs and copy the docs into the appropriate javadocs folder
8+
# (creating it if necessary) in the bullet-db.github.io git repository
9+
10+
function build_docs() {
11+
local PROJECT=$1
12+
local VERSION=$2
13+
local TAG="${PROJECT}-${VERSION}"
14+
15+
echo "Checking out repo at ${TAG}..."
16+
git checkout $TAG
17+
echo "Building docs..."
18+
make doc
19+
git checkout master
20+
}
21+
22+
function copy_docs() {
23+
local PROJECT=$1
24+
local VERSION=$2
25+
local DEST=$3
26+
27+
local PATH="${DEST}/apidocs/${PROJECT}/${VERSION}"
28+
echo "Making ${PATH} if necessary..."
29+
mkdir -p $PATH
30+
31+
echo "Copying docs to ${PATH}..."
32+
cp -r target/site/*docs/* $PATH/
33+
}
34+
35+
build_docs $1 $2
36+
copy_docs $1 $2 $3
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace me with the real documentation.

0 commit comments

Comments
 (0)