-
Notifications
You must be signed in to change notification settings - Fork 135
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
jameskr97
wants to merge
20
commits into
etternagame:develop
Choose a base branch
from
jameskr97:feature/mkdocs
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
- 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`
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.
Docs/*
intoDocs/docs/*
. Doxygen and mkdocs allow the theme to be customized through various files stored inDocs/style/*
Documentation website may be accessed through https://docs.etterna.dev