Add plantuml to docs #2975
Merged
Add plantuml to docs #2975
Conversation
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
jessica-mitchell
added
T: Enhancement
Contributor
Author
|
Merging with 1 approval, as its docs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds plantuml diagram possibilities to the documentation.
plantuml requires Java so this is installed during build on Read the Docs- This assumes we don't want to add Java as a dependency in our sphinx-build
For local builds, instructions are added to the User documentation workflow on how you can get plantuml diagrams to work.
In addition the requirements for the docs are no longer pinned to a specific version (rather changed to
>=), along with version 3.8 of Python being updated to 3.10 in the readthedocs.yml. This didnt seem to break anything and I believe is the more desired way of handling requirements.There is a temp file showing the output. An actual useful example would be better, so setting as draft for now.