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

Jupyter notebooks and doc check #161

Merged

Conversation

e10harvey
Copy link
Collaborator

Summary of changes:

  • Include foundation classes jupyter notebook in generated docs
  • Update black lint docs
  • Update docs on sphinx-build

Copy link
Collaborator

@bbean23 bbean23 left a comment

Choose a reason for hiding this comment

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

approved!

@@ -72,7 +91,7 @@ commits:
for FILE in $(git diff --cached --name-only | egrep '.*\.py$')
do
if [ -e $FILE ]; then
black $FILE -C -S
black $FILE --line-length 120 -C -S
Copy link
Collaborator

Choose a reason for hiding this comment

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

yay thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

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

At some point we need to figure out how we're going to handle jupyter notebooks in the repo. What I'd like to see is something that extracts the results out of the notebook and keeps them in a sidecar file while checked into git, then recombines the notebook and sidecar file when checked out.

This is just a note to keep us thinking. Nothing needs to be done right now.

@e10harvey e10harvey merged commit 4e145b6 into sandialabs:develop Aug 21, 2024
4 checks passed
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.

2 participants