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

Jwilber/load nb from subpackages #128

Merged
merged 8 commits into from
Sep 4, 2024
Merged

Conversation

jwilber
Copy link
Collaborator

@jwilber jwilber commented Aug 30, 2024

This automates/outlines the pulling of sub-package-specific content.
What we pull/how we structure the sub-packages is subject to change, but this outlines pulling:

  • readme's to populate sub-package content in the Developer guide tab.
  • notebooks to populate sub-package content in the Examples tab.

I expect be adding/editing automation utilities in some capacity, so I refactored the script into file-specific utility funcs, so it's easier to follow.

Below is what gets generated (again, subject to change on how this looks eventually):

Developer guide
READMEs are loaded as the main documentation entry point, for each sub-package (the tab name is the README's first header).
Screenshot 2024-08-30 at 1 36 45 PM

Examples:
Notebooks for each sub-package. This assumes that each sub-package stores them in a dir, examples/.
Screenshot 2024-08-30 at 1 36 53 PM

Copy link
Collaborator

@pstjohn pstjohn left a comment

Choose a reason for hiding this comment

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

Thanks for cleaning up gen_ref_pages.py! As discussed via slack, I think this should be pretty easy to merge with my edits in #120

docs/scripts/gen_ref_pages.py Outdated Show resolved Hide resolved
@jwilber jwilber force-pushed the jwilber/load-nb-from-subpackages branch from f92bb26 to f1d4947 Compare September 3, 2024 23:43
@jwilber
Copy link
Collaborator Author

jwilber commented Sep 4, 2024

/build-ci

@jwilber jwilber merged commit bfc3df9 into v2-main Sep 4, 2024
3 checks passed
pstjohn added a commit that referenced this pull request Sep 5, 2024
@pstjohn pstjohn deleted the jwilber/load-nb-from-subpackages branch January 17, 2025 18:57
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