Mirror
/
ardupilot
mirror of https://github.com/ArduPilot/ardupilot
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: allow docs build to output to another directory 

use DOCS_OUTPUT_BASE environment variable
This commit is contained in:
Andrew Tridgell 2013-08-15 08:58:10 +10:00
parent 33cbe6151a
commit 04eb1de7a5
10 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/build-apmrover2.sh
View File

@ -3,7 +3,9 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/.. cd $DIR/..
if [ ! -f docs/tags/libraries ]; . docs/setup.sh
if [ ! -f $DOCS_OUTPUT_BASE/tags/libraries ];
then then
echo "Must build libraries first" echo "Must build libraries first"
exit 0 exit 0

4
docs/build-arducopter.sh
View File

@ -3,7 +3,9 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/.. cd $DIR/..
if [ ! -f docs/tags/libraries ]; . docs/setup.sh
if [ ! -f $DOCS_OUTPUT_BASE/tags/libraries ];
then then
echo "Must build libraries first" echo "Must build libraries first"
exit 0 exit 0

4
docs/build-arduplane.sh
View File

@ -3,7 +3,9 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/.. cd $DIR/..
if [ ! -f docs/tags/libraries ]; . docs/setup.sh
if [ ! -f $DOCS_OUTPUT_BASE/tags/libraries ];
then then
echo "Must build libraries first" echo "Must build libraries first"
exit 0 exit 0

3
docs/build-libs.sh
View File

@ -2,4 +2,7 @@
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/.. cd $DIR/..
. docs/setup.sh
doxygen docs/config/libraries doxygen docs/config/libraries

4
docs/config/apmrover2
View File

@ -2,7 +2,7 @@
PROJECT_NAME = "APM:Rover" PROJECT_NAME = "APM:Rover"
INPUT = APMrover2/ INPUT = APMrover2/
OUTPUT_DIRECTORY = docs/APMrover2 OUTPUT_DIRECTORY = $(DOCS_OUTPUT_BASE)/APMrover2
HTML_OUTPUT = . HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries TAGFILES = $(DOCS_OUTPUT_BASE)/tags/libraries=../libraries

4
docs/config/arducopter
View File

@ -2,7 +2,7 @@
PROJECT_NAME = "APM:Copter" PROJECT_NAME = "APM:Copter"
INPUT = ArduCopter/ INPUT = ArduCopter/
OUTPUT_DIRECTORY = docs/ArduCopter OUTPUT_DIRECTORY = $(DOCS_OUTPUT_BASE)/ArduCopter
HTML_OUTPUT = . HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries TAGFILES = $(DOCS_OUTPUT_BASE)/tags/libraries=../libraries

5
docs/config/arduplane
View File

@ -2,7 +2,6 @@
PROJECT_NAME = "APM:Plane" PROJECT_NAME = "APM:Plane"
INPUT = ArduPlane/ INPUT = ArduPlane/
OUTPUT_DIRECTORY = docs/ArduPlane OUTPUT_DIRECTORY = $(DOCS_OUTPUT_BASE)/ArduPlane
HTML_OUTPUT = . HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries TAGFILES = $(DOCS_OUTPUT_BASE)/tags/libraries=../libraries

4
docs/config/default
View File

@ -615,7 +615,7 @@ CITE_BIB_FILES =
# The QUIET tag can be used to turn on/off the messages that are generated # 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. # 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 # 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 # 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 # 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. # 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 # 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 # graphs generated by dot. A depth value of 3 means that only nodes reachable

4
docs/config/libraries
View File

@ -2,6 +2,6 @@
PROJECT_NAME = "APM:Libraries" PROJECT_NAME = "APM:Libraries"
INPUT = libraries/ INPUT = libraries/
OUTPUT_DIRECTORY = docs/libraries OUTPUT_DIRECTORY = $(DOCS_OUTPUT_BASE)/libraries
HTML_OUTPUT = . HTML_OUTPUT = .
GENERATE_TAGFILE = docs/tags/libraries GENERATE_TAGFILE = $(DOCS_OUTPUT_BASE)/tags/libraries

8
docs/setup.sh Normal file
View File

@ -0,0 +1,8 @@
# setup output directory
[ -z "$DOCS_OUTPUT_BASE" ] && {
export DOCS_OUTPUT_BASE=docs
}
mkdir -p $DOCS_OUTPUT_BASE/tags