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.

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

Jump to bottom

Guide to opt-in to Notebook support in native server #547

Merged
merged 1 commit into from
Jul 22, 2024
Merged

Guide to opt-in to Notebook support in native server #547

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,20 @@ code actions, and formatting.

This requires Ruff version `v0.1.3` or later.

### Native Server

The native server supports Jupyter Notebooks out of the box. Unlike `ruff-lsp`, the native server requires
the user to explicitly include Jupyter Notebooks in the set of files to lint and format. This can be done by
updating the [`extend-include`](https://docs.astral.sh/ruff/settings/#extend-include) setting in the Ruff configuration file.

```toml
[tool.ruff]
extend-include = ["*.ipynb"]
```

Refer to the [Jupyter Notebook discovery](https://docs.astral.sh/ruff/configuration/#jupyter-notebook-discovery) section
of the Ruff documentation for more information.

[notebook document synchronization]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notebookDocument_synchronization

## Untrusted Workspace
Expand Down