Skip to content

Commit 154a59e

Browse files
committed
pre-commit: run prettier
1 parent 7f886ab commit 154a59e

File tree

10 files changed

+51
-51
lines changed

10 files changed

+51
-51
lines changed

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,5 +65,5 @@ jobs:
6565
- name: Publish to GitHub Pages
6666
if: github.ref == 'refs/heads/main'
6767
run: |
68-
pip install ghp-import
69-
ghp-import --no-jekyll --push --message "Update documentation [skip ci]" docs/_build/html
68+
pip install ghp-import
69+
ghp-import --no-jekyll --push --message "Update documentation [skip ci]" docs/_build/html

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ name: Release
77
on:
88
pull_request:
99
paths-ignore:
10-
- "docs/**"
11-
- "**/docs.yml"
10+
- "docs/**"
11+
- "**/docs.yml"
1212
push:
1313
paths-ignore:
1414
- "docs/**"

.github/workflows/test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ jobs:
4040

4141
- name: Run webpack to build static assets
4242
run: |
43-
npm install
44-
npm run webpack
43+
npm install
44+
npm run webpack
4545
4646
- name: Install dependencies
4747
run: |

CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,14 @@
3939

4040
[@akhmerov](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Aakhmerov+updated%3A2021-09-02..2022-03-18&type=Issues) | [@brian-rose](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Abrian-rose+updated%3A2021-09-02..2022-03-18&type=Issues) | [@choldgraf](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Acholdgraf+updated%3A2021-09-02..2022-03-18&type=Issues) | [@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3AconsideRatio+updated%3A2021-09-02..2022-03-18&type=Issues) | [@jameshowison](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Ajameshowison+updated%3A2021-09-02..2022-03-18&type=Issues) | [@jdmansour](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Ajdmansour+updated%3A2021-09-02..2022-03-18&type=Issues) | [@manics](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Amanics+updated%3A2021-09-02..2022-03-18&type=Issues) | [@ryanlovett](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Aryanlovett+updated%3A2021-09-02..2022-03-18&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Awelcome+updated%3A2021-09-02..2022-03-18&type=Issues) | [@yuvipanda](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Ayuvipanda+updated%3A2021-09-02..2022-03-18&type=Issues) | [@Zsailer](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3AZsailer+updated%3A2021-09-02..2022-03-18&type=Issues)
4141

42-
4342
### 1.0.2 - 2021-09-03
4443

4544
A release to fix an issue that stopped us from publishing nbgitpuller on
4645
conda-forge.
4746

4847
#### Maintenance and upkeep improvements
4948

50-
- Fix jupyter-packaging reference, use - instead of _ [#219](https://github.com/jupyterhub/nbgitpuller/pull/219) ([@consideRatio](https://github.com/consideRatio))
49+
- Fix jupyter-packaging reference, use - instead of \_ [#219](https://github.com/jupyterhub/nbgitpuller/pull/219) ([@consideRatio](https://github.com/consideRatio))
5150

5251
### 1.0.1 - 2021-09-02
5352

@@ -169,7 +168,7 @@ This is a critical security release, please upgrade to this and see [GHSA-mq5p-2
169168
- Add a mybinder.org tab to the link builder ([#129](https://github.com/jupyterhub/nbgitpuller/pull/129))
170169
- tab activation on link generator ([#132](https://github.com/jupyterhub/nbgitpuller/pull/132))
171170
- fixing bug ([#134](https://github.com/jupyterhub/nbgitpuller/pull/134))
172-
- Fix typo from ipynb link generator external tool reference ([#136](https://github.com/jupyterhub/nbgitpuller/pull/136))
171+
- Fix typo from ipynb link generator external tool reference ([#136](https://github.com/jupyterhub/nbgitpuller/pull/136))
173172
- Use the correct branch for contentRepo ([#138](https://github.com/jupyterhub/nbgitpuller/pull/138))
174173
- Fix file paths or application paths ([#140](https://github.com/jupyterhub/nbgitpuller/pull/140))
175174
- Make the environment repo branch required for binder ([#143](https://github.com/jupyterhub/nbgitpuller/pull/143))

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# [nbgitpuller](https://github.com/jupyterhub/nbgitpuller)
22

3-
43
[![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/nbgitpuller/Tests?logo=github&label=tests)](https://github.com/jupyterhub/nbgitpuller/actions)
54
[![CircleCI build status](https://img.shields.io/circleci/build/github/jupyterhub/nbgitpuller?logo=circleci&label=docs)](https://circleci.com/gh/jupyterhub/nbgitpuller)
65
[![](https://img.shields.io/pypi/v/nbgitpuller.svg?logo=pypi)](https://pypi.python.org/pypi/nbgitpuller)
@@ -25,8 +24,7 @@ pip install nbgitpuller
2524

2625
## Example
2726

28-
29-
This example shows how to use the [nbgitpuller link generator](https://jupyterhub.github.io/nbgitpuller/link)
27+
This example shows how to use the [nbgitpuller link generator](https://jupyterhub.github.io/nbgitpuller/link)
3028
to create an nbgitpuller link, which a user then clicks.
3129

3230
1. The [nbgitpuller link generator GUI](https://jupyterhub.github.io/nbgitpuller/link) is used to create a

RELEASE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
These are instructions on how to make a release on PyPI.
77
The PyPI release is done automatically by TravisCI when a tag is pushed.
88

9-
109
## Steps to make a release
1110

1211
1. Checkout main and make sure it is up to date.

docs/contributing.md

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -42,40 +42,42 @@ Hence, nbgitpuller can be developed locally without needing a JupyterHub.
4242
```
4343

4444
7. Enable the nbgitpuller extension:
45-
* as a jupyter serverextension (classic Notebook Server extension)
4645

47-
```bash
48-
jupyter serverextension enable --sys-prefix nbgitpuller
49-
```
50-
* as a jupyter server extension
51-
```bash
52-
jupyter server extension enable --sys-prefix nbgitpuller
53-
```
46+
- as a jupyter serverextension (classic Notebook Server extension)
47+
48+
```bash
49+
jupyter serverextension enable --sys-prefix nbgitpuller
50+
```
51+
52+
- as a jupyter server extension
53+
```bash
54+
jupyter server extension enable --sys-prefix nbgitpuller
55+
```
5456

5557
8. Start the notebook server:
5658

57-
* You can either start the classical Notebook server.
58-
This will open the classic notebook in your web
59-
browser, and automatically authenticate you as a side effect.
60-
61-
```bash
62-
jupyter notebook
63-
```
64-
65-
* Or you can start the new Jupyter Server.
66-
```bash
67-
jupyter server
68-
```
69-
This won't open any notebook interface, unless you don't enable one
70-
([`nbclassic`](https://github.com/jupyterlab/nbclassic) or [`jupyterlab`](https://github.com/jupyterlab/jupyterlab))
71-
as a jupyter server extension.
72-
```bash
73-
jupyter server extension enable --sys-prefix nbclassic
74-
```
75-
or
76-
```bash
77-
jupyter server extension enable --sys-prefix jupyterlab
78-
```
59+
- You can either start the classical Notebook server.
60+
This will open the classic notebook in your web
61+
browser, and automatically authenticate you as a side effect.
62+
63+
```bash
64+
jupyter notebook
65+
```
66+
67+
- Or you can start the new Jupyter Server.
68+
```bash
69+
jupyter server
70+
```
71+
This won't open any notebook interface, unless you don't enable one
72+
([`nbclassic`](https://github.com/jupyterlab/nbclassic) or [`jupyterlab`](https://github.com/jupyterlab/jupyterlab))
73+
as a jupyter server extension.
74+
```bash
75+
jupyter server extension enable --sys-prefix nbclassic
76+
```
77+
or
78+
```bash
79+
jupyter server extension enable --sys-prefix jupyterlab
80+
```
7981

8082
9. You can now test nbgitpuller locally, by hitting the `/git-pull` url with any
8183
of the [URL query parameters](topic/url-options.rst). For example, to pull the
@@ -87,8 +89,8 @@ Hence, nbgitpuller can be developed locally without needing a JupyterHub.
8789
```
8890
8991
10. If you make changes to nbgitpuller's python code, you need to restart the `jupyter notebook`
90-
process (started in step 5) to see your changes take effect. This is not needed if
91-
you are only working on the javascript or css.
92+
process (started in step 5) to see your changes take effect. This is not needed if
93+
you are only working on the javascript or css.
9294

9395
## Running the flake8 linter
9496

@@ -100,7 +102,7 @@ flake8 config is in `.flake8`, and is not super strict. You should be able to ru
100102

101103
[pytest](https://docs.pytest.org/) is used to run unit and integration tests,
102104
under the `tests/` directory. If you add new functionality, you should also add
103-
tests to cover it. You can run the tests locally with `py.test tests/`
105+
tests to cover it. You can run the tests locally with `py.test tests/`
104106

105107
## Building documentation
106108

docs/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ Here's an example of `nbgitpuller` in action:
1515
link.
1616

1717
```{image} _static/nbgitpuller-link-generator.png
18+
1819
```
1920

2021
2. A user clicks the link, and the content is pulled into a live Jupyter session.
2122

2223
```{image} _static/nbgitpuller-demo.gif
24+
2325
```
2426

2527
## Use `nbgitpuller`
@@ -35,6 +37,7 @@ Here's a short overview:
3537

3638
There are several ways to generate an `nbgitpuller` link.
3739
The two easiest ways to do so are:
40+
3841
- Via a browser extension to generate links directly from your repository ([Chrome extension](https://chrome.google.com/webstore/detail/nbgitpuller-link-generato/hpdbdpklpmppnoibabdkkhnfhkkehgnc), [Firefox extension](https://addons.mozilla.org/en-US/firefox/addon/nbgitpuller-link-generator/?utm_source=addons.mozilla.org&utm_medium=referral&utm_content=search)
3942
- Via a GUI web-app [at `nbgitpuller.link`](http://nbgitpuller.link)
4043

@@ -45,7 +48,7 @@ Fore more information about generating nbgitpuller links, see [](use.md).
4548
Use nbgitpuller when:
4649

4750
1. You want an easy way to distribute content (notebooks, markdown files, etc) to Jupyter users without requiring them to use `git`.
48-
2. You have an alternative method for *collecting* content from your users, as `nbgitpuller` does not "push", it only "pulls".
51+
2. You have an alternative method for _collecting_ content from your users, as `nbgitpuller` does not "push", it only "pulls".
4952

5053
You should **not** use nbgitpuller when:
5154

docs/topic/repo-best-practices.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ Sometimes, git's flexibility can lead to repositories that cause issues
44
when used with nbgitpuller. Here are some recommendations to make your
55
nbgitpuller experience smoother.
66

7-
87
## Never force push
98

109
Never use `--force` or `--force-with-lease` when pushing to your repositories.

docs/use.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ repository is made for the student. On successive clicks, the latest version
1818
of the remote repository is fetched, and merged automatically with the
1919
student's local copy using a {ref}`series of rules <topic/automatic-merging>`
2020
that ensure students never get merge conflicts nor lose any of their changes.
21+
2122
## Create an `nbgitpuller` link via a web extension
2223

23-
The easiest way to create an `nbgitpuller` link is via a web extension ([github repo](https://github.com/yuvipanda/nbgitpuller-link-generator-webextension)).
24+
The easiest way to create an `nbgitpuller` link is via a web extension ([github repo](https://github.com/yuvipanda/nbgitpuller-link-generator-webextension)).
2425
This allows you to quickly generate an `nbgitpuller` link directly from the content in your repository (e.g., on GitHub).
2526
See the links below to download the extension.
2627

@@ -37,8 +38,7 @@ This contains a simple web form where you paste the location of the content you'
3738

3839
## Manually create an `nbgitpuller` link
3940

40-
41-
There is a short video showing
41+
There is a short video showing
4242

4343
```{raw} html
4444
<iframe

0 commit comments

Comments
 (0)