Преглед изворни кода

doc/doxygen: add version and timestamp in html

Nathalie Furmento пре 12 година
родитељ
комит
69b0e31034

+ 20 - 1
doc/doxygen/Makefile.am

@@ -104,17 +104,35 @@ chapters/version.sty: $(chapters)
 		if test -f $$f ; then $(RM) $$f ; fi ;\
 	done
 
-#chapters/version.html: $(chapters)
+chapters/version.html: $(chapters)
+	@-for f in $(chapters) ; do \
+                if test -f $(top_srcdir)/doc/doxygen/$$f ; then stat --format=%Y $(top_srcdir)/doc/doxygen/$$f 2>/dev/null ; fi \
+        done | sort -r | head -1 > timestamp
+	@if test -s timestamp ; then \
+		LC_ALL=C date --date=@`cat timestamp` +"%d %B %Y" > timestamp_updated 2>/dev/null;\
+		LC_ALL=C date --date=@`cat timestamp` +"%B %Y" > timestamp_updated_month 2>/dev/null;\
+	fi
+	@echo "This manual documents the usage of StarPU version $(VERSION)." > $(top_srcdir)/doc/doxygen/chapters/version.html
+	@if test -s timestamp_updated ; then \
+		echo "Its contents was last updated on "`cat timestamp_updated`"." >> $(top_srcdir)/doc/doxygen/chapters/version.html;\
+	else \
+		echo "Its contents was last updated on <em>unknown_date</em>." >> $(top_srcdir)/doc/doxygen/chapters/version.html;\
+	fi
+	@-for f in timestamp timestamp_updated timestamp_updated_month ; do \
+		if test -f $$f ; then $(RM) $$f ; fi ;\
+	done
 
 EXTRA_DIST	= 		\
 	$(chapters) 		\
 	chapters/version.sty	\
+	chapters/version.html	\
 	doxygen.cfg 		\
 	refman.tex
 
 dox_inputs = $(DOX_CONFIG) 				\
 	$(chapters) 					\
 	chapters/version.sty				\
+	chapters/version.html				\
 	$(top_srcdir)/include/starpu.h			\
 	$(top_srcdir)/include/starpu_data_filters.h	\
 	$(top_srcdir)/include/starpu_data_interfaces.h	\
@@ -149,6 +167,7 @@ dox_inputs = $(DOX_CONFIG) 				\
 $(DOX_TAG): $(dox_inputs)
 	rm -fr $(DOX_HTML_DIR) $(DOX_LATEX_DIR)
 	$(DOXYGEN) $(DOX_CONFIG)
+	sed -i 's/ModuleDocumentation <\/li>/<a class="el" href="modules.html">Modules<\/a>/' html/index.html
 
 dist_pdf_DATA = $(DOX_PDF)
 

+ 6 - 0
doc/doxygen/chapters/introduction.doxy

@@ -8,6 +8,12 @@
 
 /*! \mainpage Introduction
 
+\htmlonly
+<h1><a class="anchor" id="Foreword"></a>Foreword</h1>
+\endhtmlonly
+\htmlinclude version.html
+\htmlinclude foreword.html
+
 \section Motivation Motivation
 
 \internal

+ 3 - 1
doc/doxygen/doxygen-config.cfg.in

@@ -24,7 +24,9 @@ INPUT                  = @top_srcdir@/doc/doxygen/chapters \
 			 @top_srcdir@/starpufft/starpufft.h \
 			 @top_srcdir@/sc_hypervisor/include
 
-EXAMPLE_PATH           = @top_srcdir@/doc/doxygen/chapters/code
+EXAMPLE_PATH           = @top_srcdir@/doc/doxygen \
+		       	 @top_srcdir@/doc/doxygen/chapters \
+		       	 @top_srcdir@/doc/doxygen/chapters/code
 
 INPUT_FILTER           = @top_builddir@/doc/doxygen/doxygen_filter.sh
 

+ 20 - 0
doc/doxygen/foreword.html

@@ -0,0 +1,20 @@
+<br/>
+<br/>
+Copyright &copy; 2009–2013 Université de Bordeaux 1
+<br/>
+Copyright &copy; 2010-2013 Centre National de la Recherche Scientifique
+<br/>
+Copyright &copy; 2011, 2012 Institut National de Recherche en Informatique et Automatique
+<br/>
+<br/>
+<br/>
+
+<blockquote>
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
+copy of the license is included in the section entitled “GNU Free
+Documentation License”.
+</blockquote>
+<br/>