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

documentation #295

Merged
merged 10 commits into from
Feb 14, 2025
Merged

documentation #295

merged 10 commits into from
Feb 14, 2025

Conversation

Ezarsh02
Copy link

@Ezarsh02 Ezarsh02 commented Jan 31, 2025

Describe your changes

Type of change

  • Documentation update (non-breaking change which adds functionality):
    Created Sphinx documentation for the installation and setup guide, still work in progress as I am adding other content sections.

Reference any relevant issues (don't forget the #)

Checklist before requesting a review

  • I have linted my code
  • I have verified that all unit tests pass in a clean environment and added new unit tests, as needed
  • I have verified that all docstrings are properly formatted and added new documentation, as needed
  • I have filled out the Unit Test Definition Table on confluence, as needed

Copy link
Contributor

@semaphoreP semaphoreP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Ezar, some minor comments below. Once you fix them, we can merge!

@semaphoreP semaphoreP changed the base branch from main to develop February 4, 2025 23:31
@semaphoreP
Copy link
Contributor

I'm also changing it for now that we're merging into develop.

Copy link
Contributor

@semaphoreP semaphoreP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@semaphoreP semaphoreP merged commit 9088894 into develop Feb 14, 2025
1 check passed
@semaphoreP semaphoreP deleted the update-docs branch February 14, 2025 17:04
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.

3 participants