Use Dokka and Mkdocs to generate documentation #19
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.
NOTE: This PR is for the branch
main. This PR adds a new GitHub action to generate documentation. It does this by the following:main, it runs the action. After installing the dependencies and everything, it runs Dokka to generate markdown files for each of the submodules.gh-pagesbranchThings to keep in mind for the future:
mainfor a new release, make sureupdate-docs.ymlis updated so that theLATEST_VERSIONvariable is the release number. Not sure if that version number can be pulled from an gradle file or not