#!/bin/bash # # Build the source that we will extract and use for a given version. When this # is complete, the directory doc/mlpack-${version}/ will be populated with # binding_header.md and binding_documentation.md and changelog.md, and the # doxygen/ directory. # # For mlpack-git, this is the only script that needs to be run nightly. # # This also expects src/mlpack-$1.tar.gz to exist. # # $1: version (i.e. "3.0.4"). version=$1; srcdir="$PWD/_src/mlpack-$1" docdir="$PWD/doc/mlpack-$1" doxygensrcdir="$PWD/_src/doxygen" # Get list of versions. doxygen_versions=(); for i in `ls files/mlpack-*.tar.gz | sort -r`; do doxygen_versions+=(mlpack-`basename $i .tar.gz | sed 's/mlpack-//'`); done # Unpack and patch the code if needed. Remove any old code. echo "Unpacking and patching version $version..."; cd _src/; rm -rf mlpack-$version/; # Handle git repository separately. Note that mlpack-git.tar.gz is just a # placeholder file. if [ "a$version" == "agit" ]; then git clone https://github.com/mlpack/mlpack mlpack-git/; else tar -xvzpf ../files/mlpack-$version.tar.gz; fi if [ -f markdown-patches/mlpack-$version-markdown.patch ]; then echo "Patch mlpack-$version-markdown.patch found; applying..."; cd mlpack-$version/; patch -p1 < ../markdown-patches/mlpack-$version-markdown.patch; cp ../markdown-patches/menu_bg.png src/mlpack/bindings/markdown/res/; cd ../; fi cd ../; # Remove any old directory if needed. echo "Creating output directory for Markdown output..."; rm -rf doc/mlpack-$version/; mkdir -p doc/mlpack-$version/; echo "Generating documentation for version $version..."; # Build the Markdown documentation. This assumes that each version has the # Markdown bindings available as a target. cd _src/mlpack-$version/; mkdir -p build/; cd build/; cmake -DBUILD_MARKDOWN_BINDINGS=ON ../; make -j4 markdown; if [ "$?" -ne "0" ]; then echo "Failure building Markdown bindings for version ${version}!"; exit 1; fi # Copy the Markdown documentation to the right place. cat doc/mlpack.md |\ awk '/

/ { flag=1; } /

/ { flag=0; } // { if(flag == 1) { print $0; }}' >\ ../../../doc/mlpack-$version/binding_header.md; # In the documentation we also have to fix the version links. cat doc/mlpack.md |\ awk '/

/ { flag=1; } // { if(flag == 1) { print $0; }}' |\ sed -E 's|^# mlpack [^ ]* ([^ ]*) binding documentation|# mlpack '$version' binding documentation|' >\ ../../../doc/mlpack-$version/binding_documentation.md cd ../../../; # Lastly, generate what we need to build the Doxygen documentation. option_string=""; for dv in ${doxygen_versions[@]}; do option_string="$option_string

|learning library

|' |\ sed 's/class="active" //' |\ sed 's|title="GitHub">GitHub|title="GitHub">GitHub'"$msearchbox_string"'|' >>\ _src/doxygen/header.$version.html; cd _src/mlpack-${version}/build/; # Do we need to update the Doxygen stylesheet? modified_lines=`cat ../Doxyfile | grep 'doxygen-src/header.html' | wc -l`; if [ "a$modified_lines" == "a0" ]; then # Modify the Doxyfile. sed -i "s|HTML_HEADER[ ]*=[ ]*.*$|HTML_HEADER = \"${doxygensrcdir}/header.$1.html\"|" ../Doxyfile; sed -i "s|HTML_FOOTER[ ]*=[ ]*.*$|HTML_FOOTER = \"${doxygensrcdir}/footer.html\"|" ../Doxyfile; sed -i "s|HTML_STYLESHEET[ ]*=[ ]*.*$|HTML_STYLESHEET = \"${doxygensrcdir}/doxygen.css\"|" ../Doxyfile; sed -i "s|HTML_EXTRA_STYLESHEET[ ]*=[ ]*.*$|HTML_EXTRA_STYLESHEET = \"${doxygensrcdir}/style-doxygen.css\"|" ../Doxyfile; fi # Modify other parts of the Doxyfile. sed -i "s|GENERATE_TREEVIEW[ ]*=[ ]*.*$|GENERATE_TREEVIEW = YES|" ../Doxyfile; sed -i "s|TREEVIEW_WIDTH[ ]*=[ ]*.*$|TREEVIEW_WIDTH = 220|" ../Doxyfile; sed -i "s|DISABLE_INDEX[ ]*=[ ]*.*$|DISABLE_INDEX = YES|" ../Doxyfile; echo "LAYOUT_FILE = DoxygenLayout.xml" >> ../Doxyfile; # Fix incorrect links to mlpack-git. sed -i 's/mlpack-git/mlpack-'"$version"'/g' ../doc/guide/cli_quickstart.hpp sed -i 's/mlpack-git/mlpack-'"$version"'/g' ../doc/guide/python_quickstart.hpp # Generate layout file. doxygen -l; sed -i 's| | |' DoxygenLayout.xml; # Build documentation. cmake ../ make clean; rm -rf doc/html/ make -j4 doc; # Hopefully you have four cores... :) cd doc/html/; for i in *.html; do sed -i 's| tmp.html; mv tmp.html $i; done cd ../../ # Now move the HTML to the right place. rm -rf $docdir/doxygen; mv doc/html $docdir/doxygen; # Now add the author tags to the generated tutorials. python $doxygensrcdir/tutorial_author_annotator.py doc/tutorials/ $docdir/doxygen/ # Now add the visualization to the optimizer tutorial. if [ -f "$docdir/doxygen/optimizertutorial.html" ]; then python $doxygensrcdir/optimizer_visualization_annotator.py $docdir/doxygen/optimizertutorial.html fi cd ../../../; cat _src/mlpack-${version}/HISTORY.md |\ sed -E 's|$#([0-9]*)$|[#\1](https://github.com/mlpack/mlpack/issues/\1)|g' >\ doc/mlpack-${version}/changelog.md;