Docs sourced GitHub actions - #101
Merged
Merged
Conversation
Contributor
Author
|
PR #102 continues documentation changes from here and would be merged after this PR. |
Contributor
Author
|
Made the settings change and should be okay to merge. |
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
1 participant
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.
Most importantly this PR replaces
mkdocs gh-deploywith Github's official pages artifact deployment. It now also automatically deploys after a PR (that includes documentation change) is merged to main. Additionallymkdocstringsis also added as a dependency and an initial API documentation is rendered. However, this is preliminary and would be done in subsequent PRs. Version bump to 0.3.2However, @roflmaostc you would need to make a small settings change Settings -> Pages -> Source: GitHub Actions. I hope I don't need to bother you about this after this is done. I spoke to @larsloetgering about this (as I mentioned to you) and he added me as a developer but forgot to give me the necessary rights as a maintainer. So it'd be great if this is also sorted out sooner or later :)
Also tagging @dboonz