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

add jupyter notebook support in documentation #109

Merged

Conversation

pstjohn
Copy link
Collaborator

@pstjohn pstjohn commented Aug 20, 2024

Adds support for jupyter notebook rendering in the bionemo2 docs suite. This PR adds two steps:

  • renders jupyter notebooks in the docs/docs/ directory tree as part of the mkdocs site using mkdocs-jupyter
  • adds a new test requirement in nbval that will execute jupyter notebooks in the docs directory, make sure they succeed, and optionally compare outputs for select cells.

For the second bullet, we'll need to add a new command to the github-bionemo-ci pipeline.

@pstjohn pstjohn requested review from jstjohn and jwilber August 20, 2024 18:02
@pstjohn pstjohn self-assigned this Aug 20, 2024
@pstjohn pstjohn force-pushed the pstjohn/v2-main/docs-jupyter-notebooks branch from 1f1e718 to b8317f4 Compare August 20, 2024 19:18
@pstjohn
Copy link
Collaborator Author

pstjohn commented Aug 20, 2024

Here's the resulting rendered docs page:
Screenshot 2024-08-20 at 2 35 12 PM

@pstjohn pstjohn force-pushed the pstjohn/v2-main/docs-jupyter-notebooks branch from b8317f4 to 9bf2dba Compare August 20, 2024 21:10
Copy link
Collaborator

@jstjohn jstjohn left a comment

Choose a reason for hiding this comment

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

Woo!

@pstjohn
Copy link
Collaborator Author

pstjohn commented Aug 20, 2024

/build-ci

@pstjohn pstjohn merged commit 3c8c2bc into NVIDIA:v2-main Aug 20, 2024
3 checks passed
@pstjohn pstjohn deleted the pstjohn/v2-main/docs-jupyter-notebooks branch August 20, 2024 22:42
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