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

Update docs #340

Merged
merged 36 commits into from
Aug 2, 2024
Merged

Update docs #340

merged 36 commits into from
Aug 2, 2024

Conversation

kujaku11
Copy link
Collaborator

@kujaku11 kujaku11 commented Jul 26, 2024

Updating the documentation, mainly the README.rst and index.rst files.

Recompiled the .rst files to the modern code architecture so that when the docs are compiled they reflect the existing code.

Updated aurora logo to be present on docs home page.

@kujaku11 kujaku11 changed the base branch from main to fix_issue_337 July 26, 2024 22:58
@kkappler
Copy link
Collaborator

This looks awesome! Thanks @kujaku11
This PR will also resolve the longstanding issue #194, as well as issue #336

I will review soon -- there may still be one minor change needed to make the notebooks figures correct. I'm looking into this now.

@kkappler
Copy link
Collaborator

Reviewing the warnings during docs build. Merging latest (and finished first draft) adding of doc strings from #337.

Copy link
Collaborator

@kkappler kkappler left a comment

Choose a reason for hiding this comment

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

This is a huge improvement and ready to merge into 337 branch

@kkappler kkappler merged commit be232fa into fix_issue_337 Aug 2, 2024
1 check 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