Add Doxygen functionality on Linux GitHub Workflow - #16
Open
MichaelBCG wants to merge 1 commit into
Open
Conversation
MichaelBCG
commented
Apr 10, 2024
| if line.startswith('#'): | ||
| return line | ||
|
|
||
| # Replace "\" with "/" except in specified cases |
Author
There was a problem hiding this comment.
## This comment illustrates how the script works.
## Below are the pairs of lines. The first line (which is commented) in each pair is an original line with back slashes "\". It was not be affected by the script
## The second line (which is not commented) in each pair is the result illustrating how the script processed the line above it
#\ \asdf \asdf\ asdf\ asdf\asdf \
\ /asdf /asdf/ asdf/ asdf/asdf \
# \ \asdf \asdf\ asdf\ asdf\asdf \
\ /asdf /asdf/ asdf/ asdf/asdf \
#\asdf \asdf\ asdf\ asdf\asdf
/asdf /asdf/ asdf/ asdf/asdf
#\asdf \asdf\ asdf\ asdf\asdf\
/asdf /asdf/ asdf/ asdf/asdf/
#\asdf \asdf\ asdf\ asdf \asdf
/asdf /asdf/ asdf/ asdf /asdf
#\asdf \asdf\ asdf\ asdf \asdf\
/asdf /asdf/ asdf/ asdf /asdf/
# \" \asdf \asdf\" asdf\ asdf\asdf \
\" /asdf /asdf\" asdf/ asdf/asdf \
#\" \asdf \asdf\" asdf\ asdf\asdf \
\" /asdf /asdf\" asdf/ asdf/asdf \
# HTML_FOOTER = devops\docs\doxygen-dark-theme\html_footer.html
HTML_FOOTER = devops/docs/doxygen-dark-theme/html_footer.html
# HTML_EXTRA_FILES = devops\docs\doxygen_theme_flat_design\src\img\closed-folder.png \
# devops\docs\doxygen_theme_flat_design\src\img\opened-folder.png
HTML_EXTRA_FILES = devops/docs/doxygen_theme_flat_design/src/img/closed-folder.png \
devops/docs/doxygen_theme_flat_design/src/img/opened-folder.png
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds functionality for generating code documentation with Doxygen and publishing it on GitHub Pages using Linux GitHub Workflows.
To utilize this feature, you'll need to specify branches in the doxygen-linux.yml file.
There are a couple of peculiarities when running Doxygen on Linux that I've addressed:
I've tested this functionality on my repository. Please review and merge it if appropriate.