docs: update user guide and expose pre, post and simulator api docs - #1065
Merged
Conversation
…nsys-heart into docs/update-user-guide
PipKat
reviewed
Apr 24, 2025
PipKat
reviewed
Apr 24, 2025
PipKat
reviewed
Apr 24, 2025
PipKat
reviewed
Apr 24, 2025
PipKat
reviewed
Apr 24, 2025
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
…nsys-heart into docs/update-user-guide
mhoeijm
commented
Apr 25, 2025
4 tasks
Revathyvenugopal162
previously approved these changes
Apr 28, 2025
Co-authored-by: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com>
PipKat
approved these changes
Apr 28, 2025
mhoeijm
enabled auto-merge (squash)
April 28, 2025 13:09
Revathyvenugopal162
approved these changes
Apr 28, 2025
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
4 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 aims to update and write a basic user guide for the three most relevant subpackages:
pre(preprocessor)simulatorpost(postprocessor)On top of that, adding missing
__init__.pyso that pre, post and simulator api docs are now also generated.