Skip to content

Conversation

@reneSchm
Copy link
Member

@reneSchm reneSchm commented Feb 6, 2024

Changes and Information

The github pages documentation (https://scicompmod.github.io/memilio/documentation/index.html) does not display the memilio logo correctly, since the image file is not available. Only its name is printed.

The same is true for manually generated doxygen files.

This can be fixed by setting the IMAGE_PATH variable in the docs/Doxyfile to ../docs/memilio-small.png

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

  • Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
  • New code adheres to coding guidelines
  • No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • Tests are added for new functionality and a local test run was successful
  • Appropriate documentation for new functionality has been added (Doxygen in the code and Markdown files if necessary)
  • Proper attention to licenses, especially no new third-party software with conflicting license has been added
  • (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

  • Corresponding issue(s) is/are linked and addressed
  • Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
  • Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
  • No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

@reneSchm reneSchm added the class::documentation Improvements or additions to documentation label Feb 6, 2024
@reneSchm reneSchm self-assigned this Feb 6, 2024
@reneSchm reneSchm requested a review from mknaranja February 6, 2024 09:52
@mknaranja mknaranja merged commit e0df83b into main Feb 6, 2024
@mknaranja mknaranja deleted the fix-memilio-logo-in-doxygen branch February 6, 2024 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

class::documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants