Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump Documentation build workflow action from Doxygen v1.11.0 to v1.12.0 #4861

Merged
merged 3 commits into from
Aug 10, 2024
Merged

Bump Documentation build workflow action from Doxygen v1.11.0 to v1.12.0 #4861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49659d2
Bump Doxygen v1.11.0 -> v1.12.0
AdarshRawat1 Aug 9, 2024
b2bec27
Bump Doxygen config files v1.11.0 -> v1.12.0
AdarshRawat1 Aug 9, 2024
a46323d
Added link for downloading Doxygen 1.12.0 on MacOS
AdarshRawat1 Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
View file
Open in desktop
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.11.0
DOXYGEN_VERSION: 1.12.0
DOXYGEN_AWESOME_VERSION: 2.3.3
PR_PATH: pr-preview/${{ github.event.number }}
DOMAIN: p4lang.github.io
Expand Down
40 changes: 32 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,7 @@ use them, but YMMV.

- Python 3 for scripting and running tests

- Optional: Documentation generation requires Doxygen (1.8.10 or
higher) and Graphviz (2.38.0 or higher).
- Optional: Documentation generation requires Doxygen (1.12.0) 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 @@ -288,13 +287,24 @@ pip3 install --user -r requirements.txt
**For documentation building:**

**Tools**
- Download the Doxygen 1.12.0 binary
```bash
sudo apt-get install -y doxygen graphviz
wget https://github.com/doxygen/doxygen/releases/download/Release_1_12_0/doxygen-1.12.0.linux.bin.tar.gz
```
- Extract and install Doxygen
```bash
tar xzvf doxygen-1.12.0.linux.bin.tar.gz
cd doxygen-1.12.0
sudo make install
cd ..
```
- Install Graphviz
```bash
sudo apt-get install -y graphviz
```
**Theme**
```bash
git clone --depth 1 -b v2.3.3 https://github.com/jothepro/doxygen-awesome-css ./docs/doxygen/awesome_css

```

`P4C` also depends on Google Protocol Buffers (Protobuf). `P4C` requires version
Expand Down Expand Up @@ -328,8 +338,20 @@ sudo pip3 install -r requirements.txt
**For documentation building:**

**Tools**
- Download the Doxygen 1.12.0 binary
```bash
wget https://github.com/doxygen/doxygen/releases/download/Release_1_12_0/doxygen-1.12.0.linux.bin.tar.gz
```
- Extract and install Doxygen
```bash
tar xzvf doxygen-1.12.0.linux.bin.tar.gz
cd doxygen-1.12.0
sudo make install
cd ..
```
- Install Graphviz
```bash
sudo dnf install -y doxygen graphviz
sudo dnf install -y graphviz
```
**Theme**
```bash
Expand Down Expand Up @@ -374,11 +396,13 @@ Installing on macOS:
brew link --force bison
```

Optional documentation building tools:
**Optional documentation building tools:**
- Download and install the Doxygen 1.12.0 DMG file from [here](https://github.com/doxygen/doxygen/releases/download/Release_1_12_0/Doxygen-1.12.0.dmg).
- Install Graphviz
```
brew install doxygen graphviz
brew install graphviz
```
Optional Documentation theme:
**Optional Documentation theme:**
```
git clone --depth 1 -b v2.3.3 https://github.com/jothepro/doxygen-awesome-css ./docs/doxygen/awesome_css
```
Expand Down
Loading
Loading