From 7aab90581a76a28bee0015a3a9c5741d35a323e2 Mon Sep 17 00:00:00 2001 From: Adarsh Rawat Date: Sat, 1 Feb 2025 21:42:20 +0530 Subject: [PATCH] Bump Doxygen `v1.13.0` -> `v1.13.2` (#5116) Signed-off-by: Adarsh --- .github/workflows/deploy-docs.yml | 2 +- README.md | 20 ++++++++++---------- docs/doxygen/doxygen.cfg | 25 +++++++++++++++---------- docs/doxygen/p4c_footer.html | 2 +- docs/doxygen/p4c_header.html | 2 +- docs/doxygen/p4c_layout.xml | 4 ++-- 6 files changed, 30 insertions(+), 25 deletions(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index c5906446c4f..28be5a044be 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -17,7 +17,7 @@ jobs: build-and-deploy: runs-on: ubuntu-latest env: - DOXYGEN_VERSION: 1.13.0 + DOXYGEN_VERSION: 1.13.2 DOXYGEN_AWESOME_VERSION: 2.3.4 PR_PATH: pr-preview/${{ github.event.number }} DOMAIN: p4lang.github.io diff --git a/README.md b/README.md index fabf0deddca..580302a9872 100644 --- a/README.md +++ b/README.md @@ -287,7 +287,7 @@ use them, but YMMV. - Python 3 for scripting and running tests -- Optional: Documentation generation requires Doxygen (1.13.0) and Graphviz (2.38.0 or higher). +- Optional: Documentation generation requires Doxygen (1.13.2) and Graphviz (2.38.0 or higher). Backends may have additional dependencies. The dependencies for the backends included with `P4C` are documented here: @@ -311,14 +311,14 @@ pip3 install --user -r requirements.txt **For documentation building:** **Tools** -- Download the Doxygen 1.13.0 binary +- Download the Doxygen 1.13.2 binary ```bash -wget https://github.com/doxygen/doxygen/releases/download/Release_1_13_0/doxygen-1.13.0.linux.bin.tar.gz +wget https://github.com/doxygen/doxygen/releases/download/Release_1_13_0/doxygen-1.13.2.linux.bin.tar.gz ``` - Extract and install Doxygen ```bash -tar xzvf doxygen-1.13.0.linux.bin.tar.gz -cd doxygen-1.13.0 +tar xzvf doxygen-1.13.2.linux.bin.tar.gz +cd doxygen-1.13.2 sudo make install cd .. ``` @@ -362,14 +362,14 @@ sudo pip3 install -r requirements.txt **For documentation building:** **Tools** -- Download the Doxygen 1.13.0 binary +- Download the Doxygen 1.13.2 binary ```bash -wget https://github.com/doxygen/doxygen/releases/download/Release_1_13_0/doxygen-1.13.0.linux.bin.tar.gz +wget https://github.com/doxygen/doxygen/releases/download/Release_1_13_0/doxygen-1.13.2.linux.bin.tar.gz ``` - Extract and install Doxygen ```bash -tar xzvf doxygen-1.13.0.linux.bin.tar.gz -cd doxygen-1.13.0 +tar xzvf doxygen-1.13.2.linux.bin.tar.gz +cd doxygen-1.13.2 sudo make install cd .. ``` @@ -421,7 +421,7 @@ Installing on macOS: ``` **Optional documentation building tools:** - - Download and install the Doxygen 1.13.0 DMG file from [here](https://github.com/doxygen/doxygen/releases/download/Release_1_13_0/Doxygen-1.13.0.dmg). + - Download and install the Doxygen 1.13.2 DMG file from [here](https://github.com/doxygen/doxygen/releases/download/Release_1_13_0/Doxygen-1.13.2.dmg). - Install Graphviz ``` brew install graphviz diff --git a/docs/doxygen/doxygen.cfg b/docs/doxygen/doxygen.cfg index c52d540dc0c..460f303144e 100644 --- a/docs/doxygen/doxygen.cfg +++ b/docs/doxygen/doxygen.cfg @@ -1,4 +1,4 @@ -# Doxyfile 1.13.0 +# Doxyfile 1.13.2 # This file describes the settings to be used by the documentation system # Doxygen (www.doxygen.org) for a project. @@ -2812,24 +2812,29 @@ DIR_GRAPH_MAX_DEPTH = 1 # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: # https://www.graphviz.org/)). -# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order -# to make the SVG files visible in IE 9+ (other browsers do not have this -# requirement). +# +# Note the formats svg:cairo and svg:cairo:cairo cannot be used in combination +# with INTERACTIVE_SVG (the INTERACTIVE_SVG will be set to NO). # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, -# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and -# png:gdiplus:gdiplus. +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus, +# png:gdiplus:gdiplus, svg:cairo, svg:cairo:cairo, svg:svg, svg:svg:core, +# gif:cairo, gif:cairo:gd, gif:cairo:gdiplus, gif:gdiplus, gif:gdiplus:gdiplus, +# gif:gd, gif:gd:gd, jpg:cairo, jpg:cairo:gd, jpg:cairo:gdiplus, jpg:gd, +# jpg:gd:gd, jpg:gdiplus and jpg:gdiplus:gdiplus. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. DOT_IMAGE_FORMAT = svg -# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to -# enable generation of interactive SVG images that allow zooming and panning. +# If DOT_IMAGE_FORMAT is set to svg or svg:svg or svg:svg:core, then this option +# can be set to YES to enable generation of interactive SVG images that allow +# zooming and panning. # # Note that this requires a modern browser other than Internet Explorer. Tested # and working are Firefox, Chrome, Safari, and Opera. -# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make -# the SVG files visible. Older versions of IE do not have SVG support. +# +# Note This option will be automatically disabled when DOT_IMAGE_FORMAT is set +# to svg:cairo or svg:cairo:cairo. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. diff --git a/docs/doxygen/p4c_footer.html b/docs/doxygen/p4c_footer.html index e337305b9e0..33bf752059b 100644 --- a/docs/doxygen/p4c_footer.html +++ b/docs/doxygen/p4c_footer.html @@ -1,4 +1,4 @@ - +