From 0c2b3c667bf157dc2344e3dbc2aae0e11e37387b Mon Sep 17 00:00:00 2001 From: Marti Bolivar Date: Sat, 11 Jun 2011 19:25:29 -0400 Subject: Remove reST documentation, attendant updates. The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation --- support/scripts/copy-to-ide | 20 +++----------------- 1 file changed, 3 insertions(+), 17 deletions(-) (limited to 'support/scripts') diff --git a/support/scripts/copy-to-ide b/support/scripts/copy-to-ide index 674615e..08cb9e3 100755 --- a/support/scripts/copy-to-ide +++ b/support/scripts/copy-to-ide @@ -1,12 +1,11 @@ #!/bin/sh -# This hack copies libmaple's source, linker scripts, and built -# documentation into the Maple IDE repository (which is expected as -# its first argument). +# This hack copies libmaple's source, linker scripts, and support +# libraries into the Maple IDE repository (which is expected as its +# first argument). DEST=$1 -DEST_REF=$DEST/build/shared/reference DEST_CORES=$DEST/hardware/leaflabs/cores/maple DEST_LIBS=$DEST/libraries @@ -35,9 +34,6 @@ LMAPLE_SRC="LICENSE ./support/ld/maple_RET6 ./support/ld/names.inc" -LMAPLE_DOCS=./docs -LMAPLE_DOCS_BUILD=$LMAPLE_DOCS/build/html - echo "First make sure DEST exists: $DEST" if !(test -d $DEST) then @@ -58,14 +54,4 @@ cp -R libraries/* $DEST_LIBS echo Creating libmaple-version.txt git show-ref HEAD | cut -c 1-10 > $DEST/libmaple-version.txt -# docs -echo Deleting old reference directory contents -rm -rf $DEST_REF/* - -echo Rebuilding documentation -( cd $LMAPLE_DOCS; doxygen >/dev/null 2>&1 && make clean >/dev/null 2>&1 && make html ) - -echo Copying over documentation -cp -R $LMAPLE_DOCS_BUILD/* $DEST_REF - echo Done. -- cgit v1.2.3