Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

docs: allow docs build to output to another directory

use DOCS_OUTPUT_BASE environment variable
  • Loading branch information...
commit 04eb1de7a59d2a43e6e60be2779d51be88b68571 1 parent 33cbe61
@tridge tridge authored
View
4 docs/build-apmrover2.sh
@@ -3,7 +3,9 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/..
-if [ ! -f docs/tags/libraries ];
+. docs/setup.sh
+
+if [ ! -f $DOCS_OUTPUT_BASE/tags/libraries ];
then
echo "Must build libraries first"
exit 0
View
4 docs/build-arducopter.sh
@@ -3,7 +3,9 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/..
-if [ ! -f docs/tags/libraries ];
+. docs/setup.sh
+
+if [ ! -f $DOCS_OUTPUT_BASE/tags/libraries ];
then
echo "Must build libraries first"
exit 0
View
4 docs/build-arduplane.sh
@@ -3,7 +3,9 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/..
-if [ ! -f docs/tags/libraries ];
+. docs/setup.sh
+
+if [ ! -f $DOCS_OUTPUT_BASE/tags/libraries ];
then
echo "Must build libraries first"
exit 0
View
3  docs/build-libs.sh
@@ -2,4 +2,7 @@
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/..
+
+. docs/setup.sh
+
doxygen docs/config/libraries
View
4 docs/config/apmrover2
@@ -2,7 +2,7 @@
PROJECT_NAME = "APM:Rover"
INPUT = APMrover2/
-OUTPUT_DIRECTORY = docs/APMrover2
+OUTPUT_DIRECTORY = $(DOCS_OUTPUT_BASE)/APMrover2
HTML_OUTPUT = .
-TAGFILES = docs/tags/libraries=../libraries
+TAGFILES = $(DOCS_OUTPUT_BASE)/tags/libraries=../libraries
View
4 docs/config/arducopter
@@ -2,7 +2,7 @@
PROJECT_NAME = "APM:Copter"
INPUT = ArduCopter/
-OUTPUT_DIRECTORY = docs/ArduCopter
+OUTPUT_DIRECTORY = $(DOCS_OUTPUT_BASE)/ArduCopter
HTML_OUTPUT = .
-TAGFILES = docs/tags/libraries=../libraries
+TAGFILES = $(DOCS_OUTPUT_BASE)/tags/libraries=../libraries
View
5 docs/config/arduplane
@@ -2,7 +2,6 @@
PROJECT_NAME = "APM:Plane"
INPUT = ArduPlane/
-OUTPUT_DIRECTORY = docs/ArduPlane
+OUTPUT_DIRECTORY = $(DOCS_OUTPUT_BASE)/ArduPlane
HTML_OUTPUT = .
-TAGFILES = docs/tags/libraries=../libraries
-
+TAGFILES = $(DOCS_OUTPUT_BASE)/tags/libraries=../libraries
View
4 docs/config/default
@@ -615,7 +615,7 @@ CITE_BIB_FILES =
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
-QUIET = NO
+QUIET = YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
@@ -1830,7 +1830,7 @@ MSCFILE_DIRS =
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
-DOT_GRAPH_MAX_NODES = 50
+DOT_GRAPH_MAX_NODES = 200
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
View
4 docs/config/libraries
@@ -2,6 +2,6 @@
PROJECT_NAME = "APM:Libraries"
INPUT = libraries/
-OUTPUT_DIRECTORY = docs/libraries
+OUTPUT_DIRECTORY = $(DOCS_OUTPUT_BASE)/libraries
HTML_OUTPUT = .
-GENERATE_TAGFILE = docs/tags/libraries
+GENERATE_TAGFILE = $(DOCS_OUTPUT_BASE)/tags/libraries
View
8 docs/setup.sh
@@ -0,0 +1,8 @@
+# setup output directory
+
+[ -z "$DOCS_OUTPUT_BASE" ] && {
+ export DOCS_OUTPUT_BASE=docs
+}
+
+mkdir -p $DOCS_OUTPUT_BASE/tags
+
Please sign in to comment.
Something went wrong with that request. Please try again.