-
Notifications
You must be signed in to change notification settings - Fork 8
FIREFLY-1862: Cleanup the firefly-client docs and example notebooks #76
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
base: master
Are you sure you want to change the base?
Conversation
Remove duplicate files
More restructure of test notebooks and cleanup
Fix minor bug/docs in firefly_client
Cleanup and execute other notebook doc pages
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Fix nbsphinx syntax highlighting for code cell
robyww
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jaladh-singhal gave me an overview. It looks good.
stargaser
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I only looked at a few parts, but it looks good to me.
Fixes FIREFLY-1862
examples/contents: added meaningful names/titles, merged/deleted duplicate notebooks, moved deprecated and testing notebooks to a sub directory, etc.test/directory has now becomeexamples/development_testssince that's what they are, they are not unit tests but integration tests in form of notebooks or scriptsexamples/(all notebooks and scripts, except those in subdirectories) render as html pages in the docs website for easy view and download by userconf.pyand adding a custom extensionscript_pages.py- we can get rid it when improving infrastructure to use myst-nb instead of nbsphinx (notebook->HTML renderer libraries) similar to https://github.com/Caltech-IPAC/irsa-tutorialsdocs/usage/*.rstwhich were outdated to.ipynbfiles with up-to-date API usagefirefly_client.pyTesting
See docs built from this PR-branch at https://caltech-ipac.github.io/firefly_client/pr/76/
Compare them against current docs (built from master branch): https://caltech-ipac.github.io/firefly_client/