Skip to content

Commit 3480970

Browse files
authored
Merge pull request #18 from jupyter-book/agoose77/feat-add-scientific-python
🔬 New blog post about the Scientific Python Developers Summit 2025
2 parents 8e33efc + 36b3649 commit 3480970

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: Jupyter Book at the Scientific Python 2025 Developer Summit
3+
subtitle: How the team took advantage of being co-located and working closely with Scientific Python developers.
4+
date: 2025-05-23
5+
authors:
6+
- choldgraf
7+
- fwkoch
8+
- agoose77
9+
---
10+
11+
## The Scientific Python community
12+
13+
Scientific Python is an ecosystem of open-source software packages and a community of developers and maintainers that is working ...
14+
15+
> To better coordinate the ecosystem and support the community of contributors and maintainers.
16+
>
17+
> -- https://scientific-python.org/about/
18+
19+
This month, the organizers of the 2025 Scientific Python Developer Summit invited to the Jupyter Book team to join them in Seattle, Washington, where Chris Holdgraf, Franklin Koch, and Angus Hollands spent five days talking about the Jupyter Book project and its role in the Scientific Python ecosystem.
20+
21+
:::{figure} https://media.licdn.com/dms/image/v2/D5622AQHNDxlvGlmvpQ/feedshare-shrink_800/B56ZbqLE4EHUA8-/0/1747685531808?e=1750896000&v=beta&t=EpsStwNocBZXPlgjBsNyBtubp3N7X04aC3jRQ8TrIyk
22+
23+
Photograph of Angus and Franklin co-working with Scientific Python developers during the summit. Image redistributed from [a LinkedIn post shared by Scientific Python][post].
24+
:::
25+
26+
[post]: https://www.linkedin.com/posts/scientific-python_scientificpython-activity-7330324425700966400-hPB4
27+
28+
## Our objectives
29+
30+
At the start of the week, we set out our goals for the summit:
31+
32+
1. To share the mission, vision, and goals of the Jupyter Book project.
33+
2. To identify and [eliminate obstacles for others to contribute](https://github.com/jupyter-book/team-compass/issues/19).
34+
3. To make progress on building missing features for the MyST Document Engine needed by the Scientific Python community
35+
36+
## What we achieved
37+
38+
### A demonstration of the MyST ecosystem
39+
40+
Angus and Franklin gave a short on-the-fly talk on the Jupyter Book project, walking through the high-level design of the MyST Document Engine, and explaining how the MyST AST that it produces can be rendered with different MyST Renderers.
41+
42+
:::{figure}
43+
![](https://hackmd.io/_uploads/Sy1PtPobgl.jpg)
44+
45+
Angus and Franklin talking with the Scientific Python Developer Summit attendees about the Jupyter Book project and the exciting new features in Jupyter Book 2.
46+
:::
47+
48+
Our fellow attendees asked many interesting and thought provoking questions, which set the scene for subsequent deep-dive conversations during the rest of the summit. One such conversation gave us the chance to learn more about the kinds of [improvements to executing MyST documents][execute] with Jupyter Kernels that tutorial and documentation authors were keen to see in future versions of the MyST Document Engine.
49+
50+
We also found the opportunity to talk about extensions to the MyST content-sharing [that might improve the tutorial authoring experience][sharing-improvements], and how the MyST Document Engine CLI [might be extended to simplify PR previews for documentation builds][pr-preview].
51+
52+
### Theme support to meet the needs of scientific-python.org
53+
54+
Franklin and Angus worked with Stefan van der Walt on porting over the Scientific Python Hugo Theme to the MyST Book Theme. Stefan had been working to build [support for custom footers][footer] in the Book Theme, and with contributions from the rest of the team[^team], we were able to finalise this work and merge it into MyST!
55+
56+
At the same time, Angus worked with a [new contributor Kira](https://github.com/kne42) to onboard them with contributing to MyST, and build several exciting new features:
57+
58+
- [Support for defining social links for a MyST project][social-links]
59+
- [UI components for rendering these social links][link-renderer]
60+
- [A UI button for linking to the editable contents of a MyST page][edit-button]
61+
62+
### A prototype for software API support in MyST
63+
64+
Towards the end of the summit, Franklin and Stefan worked closely together to prototype integration of a [standalone API documentation tool][api-docs] with the MyST Engine to pull in API documentation to a MyST project.
65+
66+
:::{iframe} https://www.loom.com/embed/589a947389fb49829c9b712b796d8a7d?sid=fbe32e5f-b68d-4de2-b9a5-2cee70d74a74
67+
:width: 100%
68+
Python API documentation with MyST
69+
:::
70+
71+
### An overhaul of the MyST overview and contributing docs
72+
73+
One of the most important outcomes of our time in Seattle was the significant improvements to the [MyST ecosystem overview](https://mystmd.org/guide/overview), our [contributing documentation](https://mystmd.org/guide/developer). These changes were were spearheaded by Chris and Stefan, with the rest of the Jupyter Book team[^team] helping to shape the narrative.
74+
75+
### A discussion about our practices as an open source team
76+
77+
We also discussed our team processes, with the goal of identifying minimal practices that would help others contribute to the project more effectively. This resulted in proposed practices for [encouraging more fluid PR merging](https://github.com/jupyter-book/team-compass/issues/27) and [prioritizing issues and PRs for work across the team](https://github.com/jupyter-book/team-compass/issues/28).
78+
79+
[pr-preview]: https://github.com/jupyter-book/mystmd/issues/2017
80+
[link-renderer]: https://github.com/jupyter-book/myst-theme/pull/581/files
81+
[social-links]: https://github.com/jupyter-book/mystmd/pull/2021
82+
[execute]: https://github.com/jupyter-book/mystmd/issues/2019
83+
[footer]: https://github.com/jupyter-book/myst-theme/pull/565
84+
[edit-button]: https://github.com/jupyter-book/myst-theme/pull/577
85+
[sharing-improvements]: https://github.com/jupyter-book/mystmd/issues/2018
86+
[api-docs]: https://github.com/stefanv/npdoc2json
87+
88+
## Thanks for organizing!
89+
90+
Many thanks to the [Berkeley Institute of Data Science](https://bids.berkeley.edu) and the [Scientific Python team](https://scientific-python.org) for their leadership around organizing this summit, and the [eScience Institute at UW](https://escience.washington.edu/) for hosting us.
91+
92+
[^team]: Those that could make it to the Summit, of course!

0 commit comments

Comments
 (0)