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

docs: exectutable update #262

Merged
merged 1 commit into from
Aug 14, 2023
Merged

docs: exectutable update #262

merged 1 commit into from
Aug 14, 2023

Conversation

henryiii
Copy link
Collaborator

@henryiii henryiii commented Aug 10, 2023

Start on #157? Also see #259.

Signed-off-by: Henry Schreiner <[email protected]>
Copy link
Collaborator

@danielballan danielballan left a comment

Choose a reason for hiding this comment

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

Let's leave #157 open because I would like to specifically illustrate:

  • adding a (matplotlib) figure inline
  • executing code in line, with Jupytext

We showed these in the NSLS-II guide, and they seem foundational enough to me to be worth showing directly here in this introduction to Python package documentation.

I might consider moving "Notebooks in docs" to a separate topical guide page. That is a popular thing to do, but I think one step more specialized than the essentials covered on this page. It assumes additional knowledge that scientists approaching this might not have ("What's the meaning of the 'kernel name'? How to I manage executed vs unexecuted notebooks in version control?"). It could be linked from the docs.md page but maybe not included as an essential topic in the first page we show about docs.

But as is this is all a step in the right direction, so I would support merging as is and considering future changes separately. Might need some discussion depending on whether my suggestions resonate.

@jarrodmillman jarrodmillman merged commit f2a52b4 into main Aug 14, 2023
4 checks passed
@jarrodmillman jarrodmillman deleted the henryiii/docs/exe branch August 14, 2023 10: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.

3 participants