Skip to content

Commit

Permalink
Update doxygen v1.13.0 -> v1.13.2
Browse files Browse the repository at this point in the history
Signed-off-by: Adarsh <[email protected]>
  • Loading branch information
AdarshRawat1 committed Jan 30, 2025
1 parent 2776b19 commit 5e73fd4
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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 ..
```
Expand Down Expand Up @@ -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 ..
```
Expand Down Expand Up @@ -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
Expand Down
25 changes: 15 additions & 10 deletions docs/doxygen/doxygen.cfg
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/p4c_footer.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- HTML footer for doxygen 1.13.0-->
<!-- HTML footer for doxygen 1.13.2-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/p4c_header.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- HTML header for doxygen 1.13.0-->
<!-- HTML header for doxygen 1.13.2-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
<head>
Expand Down

0 comments on commit 5e73fd4

Please sign in to comment.