WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Update contributing docs (black → ruff; conda → pip) #528

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
krassowski merged 2 commits into from
Dec 8, 2025
Merged

Update contributing docs (black → ruff; conda → pip) #528

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa8346a
Update contributing docs (black → ruff; conda → pip)
krassowski Dec 5, 2025
511c229
Update docs/source/developer/contributing.md
krassowski Dec 5, 2025
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
19 changes: 5 additions & 14 deletions docs/source/developer/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ pre-commit run

which should run any autoformatting on your code
and tell you about any errors it couldn't fix automatically.
You may also install [black integration](https://github.com/psf/black#editor-integration)
You may also install [ruff integration](https://docs.astral.sh/ruff/editors/)
into your text editor to format code automatically.

If you have already committed files before setting up the pre-commit
Expand All @@ -86,7 +86,7 @@ running other instances of Jupyter Server. You can try the following steps:

1. Uninstall all instances of the `jupyter-collaboration` package. These include any installations you made using
pip or conda
2. Run `python3 -m pip install -e .` in the jupyter_collaboration repository to install jupyter_collaboration from there
2. Run `python3 -m pip install -e .` in the jupyter-collaboration repository to install `jupyter-collaboration` from there
3. Launch with `python3 -m jupyter_server --port 8989`, and check that the browser is pointing to `localhost:8989`
(rather than the default 8888). You don't necessarily have to launch with port 8989, as long as you use
a port that is neither the default nor in use, then it should be fine.
Expand All @@ -98,32 +98,23 @@ Install dependencies:

```
pip install -e .[dev,test]
pip install -e examples/simple # to test the examples
```

To run the Python tests, use:

```
pytest jupyter_collaboration
pytest
```

## Building the Docs

To build the documentation you'll need [Sphinx](http://www.sphinx-doc.org/en/master/),
[pandoc](https://pandoc.org/) and a few other packages.

To install (and activate) a [conda environment] named `jupyter_collaboration_docs`
containing all the necessary packages (except pandoc), use:
To install the necessary packages with `pip`:

```
conda env create -f docs/environment.yml
conda activate jupyter_collaboration_docs
```

If you want to install the necessary packages with `pip` instead:

```
pip install -r docs/doc-requirements.txt
pip install -e .[docs]
```

Once you have installed the required packages, you can build the docs with:
Expand Down