From fceb0951d06df08525f032fbdf55a5c4312efb2c Mon Sep 17 00:00:00 2001 From: albert-github Date: Thu, 11 Aug 2022 14:46:43 +0200 Subject: Obsolete doxygen settings In the current master the settings - `DOT_TRANSPARENT` and `FORNULA_TRANSPARENT` are obsolete. - `DOT_FONTNAME` / `DOT_FONTSIZE` are incorporated into the new `...ATTR` settings --- src/Doxyfile.in | 63 ++++++++++++++++++++++++--------------------------------- 1 file changed, 26 insertions(+), 37 deletions(-) (limited to 'src/Doxyfile.in') diff --git a/src/Doxyfile.in b/src/Doxyfile.in index 6e0e0333..0b1a8081 100644 --- a/src/Doxyfile.in +++ b/src/Doxyfile.in @@ -1452,17 +1452,6 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX @@ -2127,26 +2116,38 @@ HAVE_DOT = YES DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification You need to make sure dot is able +# to find the font, which can be done by putting it in a standard location or by +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = Helvetica +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" + +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = @@ -2358,18 +2359,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support -- cgit v1.2.3 From fdfed55bd323b378c48100f651db8447f4285ea7 Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau Date: Fri, 16 Sep 2022 09:57:07 +0200 Subject: Force light mode --- src/Doxyfile.in | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'src/Doxyfile.in') diff --git a/src/Doxyfile.in b/src/Doxyfile.in index 0b1a8081..1ec190d9 100644 --- a/src/Doxyfile.in +++ b/src/Doxyfile.in @@ -1143,6 +1143,11 @@ HTML_EXTRA_STYLESHEET = @GUDHI_DOXYGEN_COMMON_DOC_PATH@/stylesheet.css HTML_EXTRA_FILES = +# Default here is AUTO_LIGHT which means "Automatically set the mode according +# to the user preference, use light mode if no preference is set". +# Force it to LIGHT (white), as the rest of the documentation is white. +HTML_COLORSTYLE = LIGHT + # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see -- cgit v1.2.3 From 18fa67330d5a3ba1848b9143c23cc46877e67baf Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau Date: Fri, 2 Dec 2022 09:42:45 +0100 Subject: Modifications to test biblio files in CI --- .circleci/config.yml | 20 ++++++++++++++++++++ biblio/bibliography.bib | 2 +- biblio/test/test_biblio.tex | 7 +++++++ biblio/test/test_gudhi_citation.tex | 7 +++++++ src/Doxyfile.in | 1 - src/cmake/modules/GUDHI_user_version_target.cmake | 7 +++++-- 6 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 biblio/test/test_biblio.tex create mode 100644 biblio/test/test_gudhi_citation.tex (limited to 'src/Doxyfile.in') diff --git a/.circleci/config.yml b/.circleci/config.yml index c8c0b70b..bf95d2f5 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -125,6 +125,26 @@ jobs: path: /tmp/doxygen destination: doxygen + bibliography: + docker: + - image: gudhi/doxygen_for_gudhi:latest + steps: + - checkout + - run: + name: Checkout submodules + command: | + git submodule sync + git submodule update --init + - run: + name: Test the LaTeX bibliography files + command: | + mkdir build + cd build + cmake -DWITH_GUDHI_THIRD_PARTY=OFF -DUSER_VERSION_DIR=version .. + cd biblio/test + latexmk -pdf -interaction=nonstopmode test_biblio.tex + latexmk -pdf -interaction=nonstopmode test_gudhi_citation.tex + ### With all third parties, except CGAL and Eigen diff --git a/biblio/bibliography.bib b/biblio/bibliography.bib index 0a3ef43d..d8472ad0 100644 --- a/biblio/bibliography.bib +++ b/biblio/bibliography.bib @@ -1090,7 +1090,7 @@ language={English} @ARTICLE{Reininghaus_Huber_ALL_PSSK, author = {J. Reininghaus and S. Huber and U. Bauer and R. Kwitt}, title = {A Stable Multi-Scale Kernel for Topological Machine Learning.}, - journal = {Proc. 2015 IEEE Conf. Comp. Vision & Pat. Rec. (CVPR '15)}, + journal = {Proc. 2015 IEEE Conf. Comp. Vision \& Pat. Rec. (CVPR '15)}, year = {2015} } diff --git a/biblio/test/test_biblio.tex b/biblio/test/test_biblio.tex new file mode 100644 index 00000000..97dee9ed --- /dev/null +++ b/biblio/test/test_biblio.tex @@ -0,0 +1,7 @@ +\documentclass{article} +\usepackage{hyperref} +\bibliographystyle{plainurl} +\begin{document} +\nocite{*} +\bibliography{../bibliography} +\end{document} \ No newline at end of file diff --git a/biblio/test/test_gudhi_citation.tex b/biblio/test/test_gudhi_citation.tex new file mode 100644 index 00000000..5fb2d33d --- /dev/null +++ b/biblio/test/test_gudhi_citation.tex @@ -0,0 +1,7 @@ +\documentclass{article} +\usepackage{hyperref} +\bibliographystyle{plainurl} +\begin{document} +\nocite{*} +\bibliography{../how_to_cite_gudhi} +\end{document} \ No newline at end of file diff --git a/src/Doxyfile.in b/src/Doxyfile.in index 1ec190d9..d5664a49 100644 --- a/src/Doxyfile.in +++ b/src/Doxyfile.in @@ -700,7 +700,6 @@ LAYOUT_FILE = # search path. See also \cite for info how to create references. CITE_BIB_FILES = @CMAKE_SOURCE_DIR@/biblio/bibliography.bib \ - @CMAKE_SOURCE_DIR@/biblio/how_to_cite_cgal.bib \ @CMAKE_SOURCE_DIR@/biblio/how_to_cite_gudhi.bib #--------------------------------------------------------------------------- diff --git a/src/cmake/modules/GUDHI_user_version_target.cmake b/src/cmake/modules/GUDHI_user_version_target.cmake index 2144ff6f..b9bf1414 100644 --- a/src/cmake/modules/GUDHI_user_version_target.cmake +++ b/src/cmake/modules/GUDHI_user_version_target.cmake @@ -18,14 +18,17 @@ add_custom_command(TARGET user_version PRE_BUILD COMMAND ${CMAKE_COMMAND} -E string(TIMESTAMP GUDHI_VERSION_YEAR "%Y") configure_file(${CMAKE_SOURCE_DIR}/biblio/how_to_cite_gudhi.bib.in "${CMAKE_CURRENT_BINARY_DIR}/biblio/how_to_cite_gudhi.bib" @ONLY) file(COPY "${CMAKE_SOURCE_DIR}/biblio/bibliography.bib" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/biblio/") +file(COPY "${CMAKE_SOURCE_DIR}/biblio/test" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/biblio") # append cgal citation inside bibliography - sphinx cannot deal with more than one bib file file(READ "${CMAKE_SOURCE_DIR}/biblio/how_to_cite_cgal.bib" CGAL_CITATION_CONTENT) file(APPEND "${CMAKE_CURRENT_BINARY_DIR}/biblio/bibliography.bib" "${CGAL_CITATION_CONTENT}") -# Copy biblio directory for user version +# Copy biblio files for user version add_custom_command(TARGET user_version PRE_BUILD COMMAND ${CMAKE_COMMAND} -E - copy_directory ${CMAKE_CURRENT_BINARY_DIR}/biblio ${GUDHI_USER_VERSION_DIR}/biblio) + copy ${CMAKE_CURRENT_BINARY_DIR}/biblio/bibliography.bib ${GUDHI_USER_VERSION_DIR}/biblio/bibliography.bib) +add_custom_command(TARGET user_version PRE_BUILD COMMAND ${CMAKE_COMMAND} -E + copy ${CMAKE_CURRENT_BINARY_DIR}/biblio/how_to_cite_gudhi.bib ${GUDHI_USER_VERSION_DIR}/biblio/how_to_cite_gudhi.bib) add_custom_command(TARGET user_version PRE_BUILD COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/README.md ${GUDHI_USER_VERSION_DIR}/README.md) -- cgit v1.2.3