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

Created pydocs documentation for the gv_ui modules #186

Conversation

dignojrteogalbo
Copy link
Collaborator

Fixes #156

Discussion

Created pydoc HTML for the gv_ui modules.

Testing

  • Open the HTML files in your browser
  • Make sure that you can access all the links
    image

Copy link
Collaborator

@matthew-oberg matthew-oberg left a comment

Choose a reason for hiding this comment

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

All looks good!

Copy link
Collaborator

@BraydenThompson BraydenThompson left a comment

Choose a reason for hiding this comment

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

Some of the links on the DisplayUI.html page to matplotlib.pyplot, ipyvolume, and ipywidgets don't lead to any actual page, plus a few others on different pages - maybe just have these as text not links?

Copy link
Collaborator

@BraydenThompson BraydenThompson 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!

@dignojrteogalbo dignojrteogalbo merged commit 3ae5d25 into main Apr 19, 2024
1 check passed
@dignojrteogalbo dignojrteogalbo deleted the 156-update-the-documentation-to-include-developer-facing-descriptions-of-the-new-features-and-functionalities branch April 19, 2024 02:00
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.

Update the documentation to include developer facing descriptions of the new features and functionalities.
3 participants