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.

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

Fix doxygen link, fix doxygen build and upgrade mkdocs-material #132

Merged
merged 3 commits into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions .github/workflows/build-sola.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,16 @@ jobs:
- name: Install pip dependencies
run: pip install -r docs/requirements.txt
- name: Install doxygen
run: sudo apt-get install -y doxygen
run: |
curl -LO https://github.com/doxygen/doxygen/releases/download/Release_1_9_8/doxygen-1.9.8.linux.bin.tar.gz
tar xzfv doxygen-1.9.8.linux.bin.tar.gz -C ~
rm doxygen-1.9.8.linux.bin.tar.gz
- name: Build mkdocs
run: mkdocs build
- name: Build doxygen
run: doxygen
run: |
export PATH="~/doxygen-1.9.8/bin:$PATH"
doxygen

ns-3_compile:
runs-on: ubuntu-22.04
Expand Down
7 changes: 6 additions & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,20 @@ jobs:
- name: Install pip dependencies
run: pip install -r docs/requirements.txt
- name: Install doxygen
run: sudo apt-get install -y doxygen
run: |
curl -LO https://github.com/doxygen/doxygen/releases/download/Release_1_9_8/doxygen-1.9.8.linux.bin.tar.gz
tar xzfv doxygen-1.9.8.linux.bin.tar.gz -C ~
rm doxygen-1.9.8.linux.bin.tar.gz
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Build mkdocs
run: mkdocs build
- name: Build doxygen
run: |
export PATH="~/doxygen-1.9.8/bin:$PATH"
doxygen
rm html/doxygen -r # Remove doxygen placeholder folder
mv doxygen_output/html html/doxygen
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
Expand Down
26 changes: 14 additions & 12 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
Babel==2.13.1
certifi==2023.7.22
charset-normalizer==3.2.0
click==8.1.6
charset-normalizer==3.3.2
click==8.1.7
colorama==0.4.6
ghp-import==2.1.0
idna==3.4
Jinja2==3.1.2
Markdown==3.4.4
Markdown==3.5.1
MarkupSafe==2.1.3
mergedeep==1.3.4
mkdocs==1.5.1
mkdocs-material==9.1.21
mkdocs-material-extensions==1.1.1
packaging==23.1
mkdocs==1.5.3
mkdocs-material==9.4.8
mkdocs-material-extensions==1.3
packaging==23.2
paginate==0.5.6
pathspec==0.11.2
platformdirs==3.10.0
Pygments==2.15.1
pymdown-extensions==10.1
platformdirs==3.11.0
Pygments==2.16.1
pymdown-extensions==10.3.1
python-dateutil==2.8.2
PyYAML==6.0.1
pyyaml_env_tag==0.1
regex==2023.6.3
regex==2023.10.3
requests==2.31.0
six==1.16.0
urllib3==2.0.4
urllib3==2.0.7
watchdog==3.0.0
3 changes: 0 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,5 @@ markdown_extensions:
- pymdownx.details
- admonition
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg

copyright: Copyright © The SOLA authors