Populate initial user guide docs #124
Merged
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.
Initial user guide implementation.
Instruction to build docs in dev mode:
Reference for Markdown(.md) document
For Diagram, we use sphinxcontrib-mermaid.
classDiagramto visualize Operator(as a class) with multiple input/output labels(input attributes as fields, output attributes as methods) and connections between operators(as an edge label).You can use the following statements in Jupyter notebook's markdown cell or in .md files.
Result: