strepsirrhini/office-gobmx
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
office-gobmx/solenv/bin/mkdocs.sh

225 lines
6.5 KiB
Bash
Raw Normal View History

Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
#!/usr/bin/env bash
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
#
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
# Doxygen / README doc generation
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
#
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
# See git for contributors
#
function header {
title=$1
breadcrumb=$2
output=$3
cat - > $output <<EOF
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<title>$title</title>
<style>
* { margin: 0; padding: 0; }
body { font-family: sans-serif; font-size: 12px; }
#head { padding: 20px; background: #18A303; }
#head a { color: #000; }
#body { padding: 20px; }
#foot { padding: 10px; font-size: 9px; border-top: 1px #18A303 solid; margin-top: 25px; }
p { line-height: 1.7em; margin-bottom: 1em; }
pre { margin-bottom: 0.5em; }
.multi-col { -moz-column-width: 13em; -webkit-column-width: 13em; -moz-column-gap: 1em; -webkit-column-gap: 1em; }
h1 {margin-bottom: 0.5em;}
h2,h3,h4 { margin: 1.3em 0 0.5em 0; }
ul, ol { margin: 0.5em 1.5em; }
</style>
</head>
<body>
<div id="head">
<h1>$title</h1>
<p>$breadcrumb</p>
</div>
<div id="body">
EOF
}
function footer {
output=$1
cat - >> $output <<EOF
</div>
<div id="foot">
<small>
<p>Generated by Libreoffice <a href="http://cgit.freedesktop.org/libreoffice/core/plain/solenv/bin/mkdocs.sh">Module Description Tool</a></p>
<p>Last updated:
EOF
LANG= date >> $output
cat - >> $output <<EOF
</p>
</small>
</div>
</body>
</html>
EOF
}
function proc_text {
# Local links: [[...]]
# Git links: [git:...]
# Other remote links: [...]
# Headings: == bleh ==
# Paragraphs: \n\n
sed -re ' s/\[\[([-_a-zA-Z0-9]+)\]\]/<a href="\1.html">\1<\/a>/g' - \
| sed -re ' s/\[git:([^]]+)\]/<a href="http:\/\/cgit.freedesktop.org\/libreoffice\/core\/tree\/\1">\1<\/a>/g' \
| sed -re ' s/\[([^]]+)\]/<a href="\1">\1<\/a>/g' \
| sed -re ' s/====([^=]+)====/<h4>\1<\/h4>/g' \
| sed -re ' s/===([^=]+)===/<h3>\1<\/h3>/g' \
| sed -re ' s/==([^=]+)==/<h2>\1<\/h2>/g' \
| sed -re ':a;N;$!ba;s/\n\n/<\/p><p>/g' \
| awk 'BEGIN { print "<p>" } { print } END { print "</p>" }'
}
function setup {
parm=$1
if [ -z "${!parm}" ] ; then
echo "grep \"${parm}=\" ./config_host.mk | sed -re \" s/${parm}=//\")"
echo "$parm=$(grep \"${parm}=\" ./config_host.mk | sed -re \" s/${parm}=//\")"
eval "$parm=$(grep \"${parm}=\" ./config_host.mk | sed -re \" s/${parm}=//\")"
fi
if [ -z "${!parm}" ] ; then
echo "could not determine $parm" >&2
exit 1
fi
}
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
# binaries that we need
which doxygen > /dev/null 2>&1 || {
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
echo "You need doxygen for doc generation" >&2
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
exit 1
}
which dot > /dev/null 2>&1 || {
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
echo "You need the graphviz tools to create the nice inheritance graphs" >&2
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
exit 1
}
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
# suck setup
setup "INPATH"
setup "SOLARINC"
shopt -s nullglob
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
# Title of the documentation
DOXYGEN_PROJECT_PREFIX="LibreOffice"
# get list of modules in build order - bah, blows RAM & disk, static list below
Generate docs for basic
2012-01-06 20:27:42 -06:00
INPUT_PROJECTS="o3tl basegfx basebmp basic comphelper svl vcl canvas cppcanvas oox svtools goodies drawinglayer xmloff slideshow sfx2 editeng svx writerfilter cui chart2 dbaccess sd starmath sc sw"
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
# output directory for generated documentation
BASE_OUTPUT="$1"
mkdir -p "$BASE_OUTPUT" || {
echo "Cannot create $BASE_OUTPUT"
exit 1
}
# paths for binary and configuration file
BASE_PATH=`pwd`
DOXYGEN_CFG="$2"
if test ! -f "$DOXYGEN_CFG"; then
echo "doxygen.cfg not found"
exit 1
fi
# strip -I. and bin -I prefix; exlude system headers
DOXYGEN_INCLUDE_PATH=`echo $SOLARINC | sed -e ' s/-I\.//'g | sed -e ' s/ -I/ /'g | sed -e ' s|/usr/[^ ]*| |g'`
# setup version string
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
DOXYGEN_VERSION="master"
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
###################################################
#
# Generate docs
#
###################################################
# cleanup
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
echo "cleaning up" && rm -rf $BASE_OUTPUT/*
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
# make the stuff world-readable
umask 022
# generate docs
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
echo "generating doxygen docs"
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
DOXYGEN_REF_TAGFILES=""
mkdocs: sort module list
2011-10-15 05:29:47 -05:00
for PROJECT in `echo $INPUT_PROJECTS|tr ' ' '\n'|sort|tr '\n' ' '`;
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
do
# avoid processing of full project subdirs, only add source and inc
DOXYGEN_INPUT=`printf "%s" "$PROJECT/source $PROJECT/inc "`
DOXYGEN_OUTPUT="$BASE_OUTPUT/$PROJECT"
DOXYGEN_OUR_TAGFILE="$DOXYGEN_OUTPUT/$PROJECT.tags"
DOXYGEN_PROJECTNAME="$DOXYGEN_PROJECT_PREFIX Module $PROJECT"
# export variables referenced in doxygen config file
export DOXYGEN_INPUT
export DOXYGEN_OUTPUT
export DOXYGEN_INCLUDE_PATH
export DOXYGEN_VERSION
export DOXYGEN_OUR_TAGFILE
export DOXYGEN_REF_TAGFILES
export DOXYGEN_PROJECTNAME
# debug
echo "Calling $DOXYGEN_PATH/doxygen $DOXYGEN_CFG with"
echo "Input: $DOXYGEN_INPUT"
echo "Output: $DOXYGEN_OUTPUT"
echo "Include: $DOXYGEN_INCLUDE_PATH"
echo "Version: $DOXYGEN_VERSION"
echo "Tagfile: $DOXYGEN_OUR_TAGFILE"
echo "Ref-Tags: $DOXYGEN_REF_TAGFILES"
echo "Title: $DOXYGEN_PROJECTNAME"
Remove accidental comment
2012-02-14 01:50:26 -06:00
nice -15 doxygen "$DOXYGEN_CFG" || exit 1
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
# setup referenced tagfiles for next round
DOXYGEN_REF_TAGFILES="$DOXYGEN_REF_TAGFILES $DOXYGEN_OUR_TAGFILE=$BASE_URL/$PROJECT/html"
done
# generate entry page
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
echo "generating index page"
header "LibreOffice Modules" " " "$BASE_OUTPUT/index.html"
for module_name in *; do
if [ -d $module_name ]; then
cur_file=$(echo $module_name/README* $module_name/readme.txt*)
if [ -f "$cur_file" ]; then
# write index.html entry
text="<h2><a href=\"${module_name}.html\">${module_name}</a></h2>\n"
text="${text}$(head -n1 $cur_file | proc_text )"
echo -e $text >> "$BASE_OUTPUT/index.html"
# write detailed module content
header "$module_name" "<a href=\"index.html\">LibreOffice</a> &raquo; ${module_name}" "$BASE_OUTPUT/${module_name}.html"
text="<p><b>View module in:</b>"
text="${text} &nbsp; <a href=\"http://cgit.freedesktop.org/libreoffice/core/tree/${module_name}\">cgit</a>"
if $(echo $INPUT_PROJECTS | grep -q $module_name); then
text="${text} &nbsp; <a href=\"${module_name}/html/classes.html\">Doxygen</a>"
fi
text="${text} </p><p>&nbsp;</p>"
echo -e $text >> "$BASE_OUTPUT/${module_name}.html"
proc_text < $cur_file >> "$BASE_OUTPUT/${module_name}.html"
footer "$BASE_OUTPUT/${module_name}.html"
else
empty_modules[${#empty_modules[*]}]=$module_name
fi
fi
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
done
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
if [ ${#empty_modules[*]} -gt 0 ]; then
echo -e "<p>&nbsp;</p><p>READMEs were not available for these modules:</p><ul>\n" >> "$BASE_OUTPUT/index.html"
for module_name in "${empty_modules[@]}"; do
echo -e "<li><a href=\"http://cgit.freedesktop.org/libreoffice/core/tree/${module_name}\">${module_name}</a></li>\n" >> "$BASE_OUTPUT/index.html"
done
echo -e "</ul>\n" >> "$BASE_OUTPUT/index.html"
fi
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
Integrate Josh Heidenreich's nice README parser as start page. From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-02-13 05:44:47 -06:00
footer "$BASE_OUTPUT/index.html"
Migrate id, tags, and docs make target over from build repo * make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
2010-12-13 15:47:09 -06:00
## done
Reference in a new issue Copy permalink