Просмотр исходного кода

doc:
- move images to sub-directory
- fix doc generation

Nathalie Furmento лет назад: 8
Родитель
Сommit
219bcae91d
43 измененных файлов с 19 добавлено и 25314 удалено
  1. 7 1
      doc/Makefile.am
  2. 9 60
      doc/doxygen/Makefile.am
  3. 0 0
      doc/doxygen/chapters/images/data_trace.eps
  4. 0 0
      doc/doxygen/chapters/images/data_trace.pdf
  5. 0 0
      doc/doxygen/chapters/images/data_trace.png
  6. 0 0
      doc/doxygen/chapters/images/distrib_data.eps
  7. 0 0
      doc/doxygen/chapters/images/distrib_data.pdf
  8. 0 0
      doc/doxygen/chapters/images/distrib_data.png
  9. 0 0
      doc/doxygen/chapters/images/distrib_data_histo.eps
  10. 0 0
      doc/doxygen/chapters/images/distrib_data_histo.pdf
  11. 0 0
      doc/doxygen/chapters/images/distrib_data_histo.png
  12. 0 0
      doc/doxygen/chapters/images/paje_draw_histogram.eps
  13. 0 0
      doc/doxygen/chapters/images/paje_draw_histogram.pdf
  14. 0 0
      doc/doxygen/chapters/images/paje_draw_histogram.png
  15. 0 0
      doc/doxygen/chapters/images/parallel_worker2.eps
  16. 0 0
      doc/doxygen/chapters/images/parallel_worker2.pdf
  17. 0 0
      doc/doxygen/chapters/images/parallel_worker2.png
  18. 0 0
      doc/doxygen/chapters/images/runtime-par.eps
  19. 0 0
      doc/doxygen/chapters/images/runtime-par.pdf
  20. 0 0
      doc/doxygen/chapters/images/runtime-par.png
  21. 0 0
      doc/doxygen/chapters/images/starpu_chol_model_11_type.eps
  22. 0 0
      doc/doxygen/chapters/images/starpu_chol_model_11_type.pdf
  23. 0 0
      doc/doxygen/chapters/images/starpu_chol_model_11_type.png
  24. 0 0
      doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based.eps
  25. 0 0
      doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based.pdf
  26. 0 0
      doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based.png
  27. 0 0
      doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based_2.eps
  28. 0 0
      doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based_2.pdf
  29. 0 0
      doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based_2.png
  30. 0 0
      doc/doxygen/chapters/images/starpu_starpu_slu_lu_model_11.eps
  31. 0 0
      doc/doxygen/chapters/images/starpu_starpu_slu_lu_model_11.pdf
  32. 0 0
      doc/doxygen/chapters/images/starpu_starpu_slu_lu_model_11.png
  33. 0 0
      doc/doxygen/chapters/images/tasks_size_overhead.eps
  34. 0 0
      doc/doxygen/chapters/images/tasks_size_overhead.pdf
  35. 0 0
      doc/doxygen/chapters/images/tasks_size_overhead.png
  36. 0 0
      doc/doxygen/chapters/images/temanejo.png
  37. 0 1166
      doc/doxygen/chapters/parallel_worker1.eps
  38. BIN
      doc/doxygen/chapters/parallel_worker1.pdf
  39. BIN
      doc/doxygen/chapters/parallel_worker1.png
  40. 0 24085
      doc/doxygen/chapters/runtime-seq.eps
  41. BIN
      doc/doxygen/chapters/runtime-seq.pdf
  42. BIN
      doc/doxygen/chapters/runtime-seq.png
  43. 3 2
      doc/doxygen/doxygen-config.cfg.in

+ 7 - 1
doc/Makefile.am

@@ -1,6 +1,6 @@
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 #
-# Copyright (C) 2013, 2014, 2016  CNRS
+# Copyright (C) 2013, 2014, 2016, 2017  CNRS
 #
 # StarPU is free software; you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -29,6 +29,12 @@ EXTRA_DIST =    tutorial/hello_world.c \
 		tutorial/vector_scal_plugin.c \
 		tutorial/vector_scal_plugin_cuda.cu
 
+if !BUILD_DOC
+EXTRA_DIST	+=	$(top_srcdir)/doc/doxygen/starpu.pdf \
+			$(top_srcdir)/doc/doxygen/html
+
+endif
+
 txtdir = ${docdir}/tutorial
 txt_DATA = $(EXTRA_DIST)
 

+ 9 - 60
doc/doxygen/Makefile.am

@@ -1,7 +1,7 @@
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 #
 # Copyright (C) 2009, 2011, 2013-2014  Université de Bordeaux
-# Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016  CNRS
+# Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017  CNRS
 # Copyright (C) 2014  INRIA
 #
 # StarPU is free software; you can redistribute it and/or modify
@@ -19,12 +19,7 @@ DOXYGEN = doxygen
 PDFLATEX = pdflatex
 MAKEINDEX = makeindex
 
-if BUILD_DOC
 DOX_DIR = $(top_builddir)/doc/doxygen
-else
-DOX_DIR = $(top_srcdir)/doc/doxygen
-endif
-
 DOX_CONFIG = $(top_srcdir)/doc/doxygen/doxygen.cfg
 
 DOX_HTML_DIR = html
@@ -32,6 +27,13 @@ DOX_LATEX_DIR = latex
 DOX_PDF = $(DOX_DIR)/starpu.pdf
 DOX_TAG = starpu.tag
 
+if BUILD_DOC
+all: $(DOX_HTML_DIR) $(DOX_PDF)
+EXTRA_DIST = $(DOX_HTML_DIR) $(DOX_PDF)
+else
+EXTRA_DIST = $(top_srcdir)/doc/doxygen/starpu.pdf $(top_srcdir)/doc/doxygen/html
+endif
+
 chapters =	\
 	chapters/000_introduction.doxy		\
 	chapters/101_building.doxy		\
@@ -162,55 +164,6 @@ chapters/version.html: $(chapters)
 		if test -f $$f ; then $(RM) $$f ; fi ;\
 	done
 
-if BUILD_DOC
-EXTRA_DIST	= 					\
-	$(chapters) 					\
-	chapters/version.sty				\
-	chapters/version.html				\
-	chapters/data_trace.eps				\
-	chapters/data_trace.pdf				\
-	chapters/data_trace.png				\
-	chapters/distrib_data.png	\
-	chapters/distrib_data.eps	\
-	chapters/distrib_data.pdf	\
-	chapters/distrib_data_histo.png	\
-	chapters/distrib_data_histo.eps	\
-	chapters/distrib_data_histo.pdf	\
-	chapters/paje_draw_histogram.eps	\
-	chapters/paje_draw_histogram.png	\
-	chapters/paje_draw_histogram.pdf	\
-	chapters/parallel_worker1.eps		\
-	chapters/parallel_worker1.pdf		\
-	chapters/parallel_worker1.png		\
-	chapters/parallel_worker2.eps		\
-	chapters/parallel_worker2.pdf		\
-	chapters/parallel_worker2.png		\
-	chapters/runtime-par.eps			\
-	chapters/runtime-par.pdf			\
-	chapters/runtime-par.png			\
-	chapters/runtime-seq.eps			\
-	chapters/runtime-seq.pdf			\
-	chapters/runtime-seq.png			\
-	chapters/starpu_chol_model_11_type.png	\
-	chapters/starpu_chol_model_11_type.eps	\
-	chapters/starpu_chol_model_11_type.pdf	\
-	chapters/starpu_non_linear_memset_regression_based.png	\
-	chapters/starpu_non_linear_memset_regression_based.eps	\
-	chapters/starpu_non_linear_memset_regression_based.pdf	\
-	chapters/starpu_non_linear_memset_regression_based_2.png	\
-	chapters/starpu_non_linear_memset_regression_based_2.eps	\
-	chapters/starpu_non_linear_memset_regression_based_2.pdf	\
-	chapters/starpu_starpu_slu_lu_model_11.png	\
-	chapters/starpu_starpu_slu_lu_model_11.eps	\
-	chapters/starpu_starpu_slu_lu_model_11.pdf	\
-	chapters/tasks_size_overhead.png		\
-	chapters/tasks_size_overhead.eps		\
-	chapters/tasks_size_overhead.pdf		\
-	chapters/temanejo.png		\
-	doxygen.cfg 					\
-	refman.tex					\
-	$(DOX_HTML_DIR)
-endif
 
 dox_inputs = $(DOX_CONFIG) 				\
 	$(chapters) 					\
@@ -278,12 +231,9 @@ $(DOX_TAG): $(dox_inputs)
 	@$(SED) -i '/\\begin{titlepage}/,$$d' $(DOX_LATEX_DIR)/refman.tex
 	@cat $(top_srcdir)/doc/doxygen/refman.tex >> $(DOX_LATEX_DIR)/refman.tex
 
-if BUILD_DOC
-EXTRA_DIST += $(DOX_PDF)
-
 $(DOX_PDF): $(DOX_TAG) refman.tex
 	@cp $(top_srcdir)/doc/doxygen/chapters/version.sty $(DOX_LATEX_DIR)
-	@cp $(top_srcdir)/doc/doxygen/chapters/*pdf $(DOX_LATEX_DIR)
+	@cp $(top_srcdir)/doc/doxygen/chapters/images/*pdf $(DOX_LATEX_DIR)
 	@echo $(PDFLATEX) $(DOX_LATEX_DIR)/refman.tex
 	@cd $(DOX_LATEX_DIR) ;\
 	rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out ;\
@@ -310,7 +260,6 @@ CLEANFILES = $(DOX_TAG) starpu_config.h \
     $(DOX_HTML_DIR) \
     $(DOX_LATEX_DIR) \
     $(DOX_PDF)
-endif
 
 # Rule to update documentation on web server. Should only be used locally.
 PUBLISHHOST	?= gforge

doc/doxygen/chapters/data_trace.eps → doc/doxygen/chapters/images/data_trace.eps


doc/doxygen/chapters/data_trace.pdf → doc/doxygen/chapters/images/data_trace.pdf


doc/doxygen/chapters/data_trace.png → doc/doxygen/chapters/images/data_trace.png


doc/doxygen/chapters/distrib_data.eps → doc/doxygen/chapters/images/distrib_data.eps


doc/doxygen/chapters/distrib_data.pdf → doc/doxygen/chapters/images/distrib_data.pdf


doc/doxygen/chapters/distrib_data.png → doc/doxygen/chapters/images/distrib_data.png


doc/doxygen/chapters/distrib_data_histo.eps → doc/doxygen/chapters/images/distrib_data_histo.eps


doc/doxygen/chapters/distrib_data_histo.pdf → doc/doxygen/chapters/images/distrib_data_histo.pdf


doc/doxygen/chapters/distrib_data_histo.png → doc/doxygen/chapters/images/distrib_data_histo.png


doc/doxygen/chapters/paje_draw_histogram.eps → doc/doxygen/chapters/images/paje_draw_histogram.eps


doc/doxygen/chapters/paje_draw_histogram.pdf → doc/doxygen/chapters/images/paje_draw_histogram.pdf


doc/doxygen/chapters/paje_draw_histogram.png → doc/doxygen/chapters/images/paje_draw_histogram.png


doc/doxygen/chapters/parallel_worker2.eps → doc/doxygen/chapters/images/parallel_worker2.eps


doc/doxygen/chapters/parallel_worker2.pdf → doc/doxygen/chapters/images/parallel_worker2.pdf


doc/doxygen/chapters/parallel_worker2.png → doc/doxygen/chapters/images/parallel_worker2.png


doc/doxygen/chapters/runtime-par.eps → doc/doxygen/chapters/images/runtime-par.eps


doc/doxygen/chapters/runtime-par.pdf → doc/doxygen/chapters/images/runtime-par.pdf


doc/doxygen/chapters/runtime-par.png → doc/doxygen/chapters/images/runtime-par.png


doc/doxygen/chapters/starpu_chol_model_11_type.eps → doc/doxygen/chapters/images/starpu_chol_model_11_type.eps


doc/doxygen/chapters/starpu_chol_model_11_type.pdf → doc/doxygen/chapters/images/starpu_chol_model_11_type.pdf


doc/doxygen/chapters/starpu_chol_model_11_type.png → doc/doxygen/chapters/images/starpu_chol_model_11_type.png


doc/doxygen/chapters/starpu_non_linear_memset_regression_based.eps → doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based.eps


doc/doxygen/chapters/starpu_non_linear_memset_regression_based.pdf → doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based.pdf


doc/doxygen/chapters/starpu_non_linear_memset_regression_based.png → doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based.png


doc/doxygen/chapters/starpu_non_linear_memset_regression_based_2.eps → doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based_2.eps


doc/doxygen/chapters/starpu_non_linear_memset_regression_based_2.pdf → doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based_2.pdf


doc/doxygen/chapters/starpu_non_linear_memset_regression_based_2.png → doc/doxygen/chapters/images/starpu_non_linear_memset_regression_based_2.png


doc/doxygen/chapters/starpu_starpu_slu_lu_model_11.eps → doc/doxygen/chapters/images/starpu_starpu_slu_lu_model_11.eps


doc/doxygen/chapters/starpu_starpu_slu_lu_model_11.pdf → doc/doxygen/chapters/images/starpu_starpu_slu_lu_model_11.pdf


doc/doxygen/chapters/starpu_starpu_slu_lu_model_11.png → doc/doxygen/chapters/images/starpu_starpu_slu_lu_model_11.png


doc/doxygen/chapters/tasks_size_overhead.eps → doc/doxygen/chapters/images/tasks_size_overhead.eps


doc/doxygen/chapters/tasks_size_overhead.pdf → doc/doxygen/chapters/images/tasks_size_overhead.pdf


doc/doxygen/chapters/tasks_size_overhead.png → doc/doxygen/chapters/images/tasks_size_overhead.png


doc/doxygen/chapters/temanejo.png → doc/doxygen/chapters/images/temanejo.png


Разница между файлами не показана из-за своего большого размера
+ 0 - 1166
doc/doxygen/chapters/parallel_worker1.eps


BIN
doc/doxygen/chapters/parallel_worker1.pdf


BIN
doc/doxygen/chapters/parallel_worker1.png


Разница между файлами не показана из-за своего большого размера
+ 0 - 24085
doc/doxygen/chapters/runtime-seq.eps


BIN
doc/doxygen/chapters/runtime-seq.pdf


BIN
doc/doxygen/chapters/runtime-seq.png


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

@@ -1,7 +1,7 @@
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 #
 # Copyright (C) 2009-2013  Université de Bordeaux
-# Copyright (C) 2010, 2011, 2012, 2013, 2014, 2016  CNRS
+# Copyright (C) 2010, 2011, 2012, 2013, 2014, 2016, 2017  CNRS
 # Copyright (C) 2011  Télécom-SudParis
 # Copyright (C) 2011, 2012  INRIA
 #
@@ -74,4 +74,5 @@ INPUT_FILTER           = @top_builddir@/doc/doxygen/doxygen_filter.sh
 
 #LATEX_HEADER           = @top_srcdir@/doc/doxygen/refman.tex
 
-IMAGE_PATH             = @top_srcdir@/doc/doxygen/chapters
+IMAGE_PATH             = @top_srcdir@/doc/doxygen/chapters/images
+