Skip to content

Conversation

@jaladh-singhal
Copy link
Member

@jaladh-singhal jaladh-singhal commented Jan 14, 2026

Fixes FIREFLY-1862

  • Restructured examples/ contents: added meaningful names/titles, merged/deleted duplicate notebooks, moved deprecated and testing notebooks to a sub directory, etc.
    • test/ directory has now become examples/development_tests since that's what they are, they are not unit tests but integration tests in form of notebooks or scripts
  • Made examples/ (all notebooks and scripts, except those in subdirectories) render as html pages in the docs website for easy view and download by user
    • This required changes in conf.py and adding a custom extension script_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-tutorials
  • Converted most of docs/usage/*.rst which were outdated to .ipynb files with up-to-date API usage
  • Fixed bugs/docstrings in firefly_client.py
  • Updated publish doc workflow to build html docs for PR branches too
  • Updated dev docs, demo-notebooks page, landing page, etc

Testing

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/

@jaladh-singhal jaladh-singhal self-assigned this Jan 14, 2026
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@jaladh-singhal jaladh-singhal marked this pull request as ready for review January 15, 2026 02:54
Copy link
Contributor

@robyww robyww left a 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.

Copy link
Collaborator

@stargaser stargaser left a 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.

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.

4 participants