Skip to content

Commit

Permalink
documentation: configuring doxyfile for publishing documentation in g…
Browse files Browse the repository at this point in the history
…ithub pages
  • Loading branch information
fabricix committed Oct 31, 2024
1 parent 264d6d0 commit 3a3344a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 22 deletions.
24 changes: 4 additions & 20 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,30 +20,14 @@ jobs:
- name: Install Graphviz (if needed for diagrams)
run: sudo apt-get install graphviz -y

- name: Install LaTeX for PDF generation
run: sudo apt-get install -y texlive-full

- name: Generate Documentation (HTML and PDF)
run: |
- name: Generate Documentation
run:
cd doxygen
doxygen Doxyfile
cd latex
make
- name: Archive the generated PDF
if: github.ref == 'refs/heads/main'
uses: actions/upload-artifact@v3
with:
name: documentation-pdf
path: doxygen/latex/refman.pdf

- name: Deploy to GitHub Pages (for HTML documentation)
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doxige/html
publish_branch: gh-pages

- name: Copy PDF to GitHub Pages directory
run: cp doxygen/latex/refman.pdf ./doxygen/html/documentation.pdf
publish_dir: ./docs
4 changes: 2 additions & 2 deletions doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1184,7 +1184,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_OUTPUT = html
HTML_OUTPUT = docs

# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
Expand Down Expand Up @@ -1737,7 +1737,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.

GENERATE_LATEX = YES
GENERATE_LATEX =

# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
Expand Down

0 comments on commit 3a3344a

Please sign in to comment.