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

📚 GitHub pages to use mkdocs-material, add theme to doxygen #1233

Open
wants to merge 20 commits into
base: develop
Choose a base branch
from

Conversation

jameskr97
Copy link
Member

@jameskr97 jameskr97 commented Jan 16, 2023

  • Added jothepro/doxygen-awesome-css with Etterna color scheme and logo.
  • Switched to mkdocs-material with Etterna color scheme.
  • Moved true documentation files from Docs/* into Docs/docs/*. Doxygen and mkdocs allow the theme to be customized through various files stored in Docs/style/*

Documentation website may be accessed through https://docs.etterna.dev

- DOCS_ONLY will cause DocumentationTools.cmake to be processed. If we're only building docs, running the full CMake is unnecessary.
- doxygen-awesome-css was downloaded for a better looking doxygen
- DOCS_OUTPUT_DIR created to coordinate output location among the different documentation software.
CMake is used to account for possible different documentation output based on the build.
The actual documentation files should have a separation from the files which will be configuring those documentation files.
Output will be within the mkdocs generation folder
Various customizations have been added, though needs significant review before finalization.
The one .md file in the InputHandler folder gets included in the doxygen.
The blue highlighted color might be worth switching away from, and the doxygen homepage could be updated to be, not empty.
- Update Doxyfile.in to change logo and reorder custom stylesheets.
- Add transparent version of etterna-logo-light.svg
- Update header.html and style.css customzations
doxygen in the repo is not the latest.
This tag is not applicable to `actions/upload-pages-artifact@v1`
@jameskr97 jameskr97 changed the base branch from master to develop January 16, 2023 07:10
@jameskr97 jameskr97 self-assigned this Feb 13, 2023
@jameskr97 jameskr97 marked this pull request as ready for review February 13, 2023 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant