Skip to content

Rename the _notebooks folder to notebooks #300

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.

Sign up for GitHub

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

Merged
palewire merged 1 commit into from
Nov 5, 2026
Merged

Rename the _notebooks folder to notebooks #300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,11 @@ human approval.

## Working on Notebooks with an Assistant

Notebooks live in `_notebooks/`. An assistant can read, edit, and run cells in
Notebooks live in `notebooks/`. An assistant can read, edit, and run cells in
an open JupyterLab notebook while the person watches the changes appear in
their browser tab. This relies on `jupyter-collaboration`, which is in the
`notebooks` dependency group. Each notebook is paired with a `.py` twin by
Jupytext (see `_notebooks/jupytext.toml`) so reviewers get a readable diff.
Jupytext (see `notebooks/jupytext.toml`) so reviewers get a readable diff.

Set this up once per person. The token is a secret: never commit it, and never
launch JupyterLab with an empty token.
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

### Changed

- Rename the `_notebooks/` folder to `notebooks/`, the more common convention
([#300]).

### Fixed

### Removed
Expand Down Expand Up @@ -103,3 +106,4 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
[#278]: https://github.com/palewire/python-open-source-template/pull/278
[#297]: https://github.com/palewire/python-open-source-template/pull/297
[#298]: https://github.com/palewire/python-open-source-template/pull/298
[#300]: https://github.com/palewire/python-open-source-template/pull/300
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ the [release checklist](RELEASING.md).

## Notebooks

Notebooks live in `_notebooks/` and are paired with `.py` files by Jupytext.
Notebooks live in `notebooks/` and are paired with `.py` files by Jupytext.
Run `make notebooks` to launch JupyterLab with live collaboration enabled. See
`AGENTS.md` for how to connect an AI assistant to an open notebook.

Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ include SECURITY.md
include TEMPLATE_SETUP.md
include uv.lock
include zizmor.yml
recursive-include _notebooks *.toml
recursive-include notebooks *.toml
recursive-include .devcontainer *
recursive-include .github *
recursive-include docs *.md *.py Makefile
Expand Down
0 _notebooks/jupytext.toml → notebooks/jupytext.toml
View file
Open in desktop
File renamed without changes.
Loading