Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #368

Merged
merged 9 commits into from
Oct 3, 2024
Merged

Docs #368

merged 9 commits into from
Oct 3, 2024

Conversation

dzalkind
Copy link
Collaborator

@dzalkind dzalkind commented Jul 12, 2024

Description and Purpose

Copy of @abhineet-gupta 's notes from #371:
This pull request implements the use of automatic documentation for documenting examples.
This is demonstrated with example-1.

Examples need to be modified so that the code is contained within a function.
Otherwise, examples get executed while building the documentation.
Also, the docstrings of other examples need to be modified to be in suitabl rst format like example-1

Type of change

What types of change is it?
Select the appropriate type(s) that describe this PR

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

TODO Items General:

  • Add example/test for new feature
  • Update registry
  • Run testing

TODO Items API Change:

  • Update docs with API change
  • Run update_rosco_discons.py in Test_Cases/
  • Update DISCON schema

Github issues addressed, if one exists

Examples/Testing, if applicable

@abhineet-gupta abhineet-gupta self-assigned this Jul 12, 2024
@abhineet-gupta
Copy link
Collaborator

Fixed the issue with readthedocs and it builds now.

@dzalkind dzalkind merged commit 632c502 into main Oct 3, 2024
55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants