Skip to content

Commit

Permalink
Merge pull request #3 from KredeGC/dev
Browse files Browse the repository at this point in the history
Docs generation
  • Loading branch information
KredeGC authored Feb 3, 2023
2 parents 1211b7e + 3a3cee4 commit 17d53b9
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 18 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Docs

on:
workflow_dispatch:
inputs:
tagName:
description: 'Test'
type: boolean

jobs:
Docs:
runs-on: ubuntu-latest
permissions:
actions: read
contents: write
pull-requests: write
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Checkout doxygen awesome
uses: actions/checkout@v3
with:
repository: jothepro/doxygen-awesome-css
path: doxygen-awesome-css
- name: Install doxygen & zip
run: sudo apt-get update && sudo apt-get install doxygen graphviz zip -y
- name: Generate Doxygen Documentation
run: doxygen Doxyfile
- name: Create .nojekyll
run: touch docs/html/.nojekyll
- name: Deploy Documentation to branch
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: docs
folder: docs/html
11 changes: 0 additions & 11 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,6 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install doxygen & zip
run: sudo apt-get update && sudo apt-get install doxygen graphviz zip -y
- name: Generate Doxygen Documentation
run: doxygen Doxyfile
- name: Create .nojekyll
run: touch docs/html/.nojekyll
- name: Deploy Documentation to branch
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: docs
folder: docs/html
- name: Copy LICENSE
run: cp LICENSE include/bitstream/LICENSE
- name: Copy NETSTACKLICENSE
Expand Down
14 changes: 7 additions & 7 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ FILE_PATTERNS = *.c \
*.ice
RECURSIVE = YES
EXCLUDE = test \
doxygen-awesome
doxygen-awesome-css
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
Expand Down Expand Up @@ -215,14 +215,14 @@ IGNORE_PREFIX =
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER = doxygen-awesome/header.html
HTML_HEADER = doxygen-awesome-css/doxygen-custom/header.html
HTML_FOOTER =
HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = doxygen-awesome/doxygen-awesome.css \
doxygen-awesome/doxygen-awesome-sidebar-only.css
HTML_EXTRA_FILES = doxygen-awesome/doxygen-awesome-fragment-copy-button.js \
doxygen-awesome/doxygen-awesome-paragraph-link.js \
doxygen-awesome/doxygen-awesome-interactive-toc.js
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
doxygen-awesome-css/doxygen-awesome-sidebar-only.css
HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
doxygen-awesome-css/doxygen-awesome-interactive-toc.js
HTML_COLORSTYLE = AUTO_LIGHT
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 100
Expand Down

0 comments on commit 17d53b9

Please sign in to comment.