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.

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

Overhaul docs toolchain #3673

Merged
merged 30 commits into from
Jan 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
b6f9346
start work on docs build, add ts metapackage, more verbose build output
bollwyvl Jan 21, 2023
619f7fe
mostly-building docs
bollwyvl Jan 21, 2023
4b4280d
start replacing nbsphinx meta
bollwyvl Jan 21, 2023
5ae0223
work on nav, header refs
bollwyvl Jan 22, 2023
47bdcc6
clean up more warnings
bollwyvl Jan 22, 2023
6d79ac0
add autodoc
bollwyvl Jan 22, 2023
f1cd039
more metadata
bollwyvl Jan 22, 2023
1c2ec1a
linting
bollwyvl Jan 22, 2023
9a99005
update, deduplicate yarn.lock
bollwyvl Jan 22, 2023
8497a34
update some dev tools
bollwyvl Jan 22, 2023
ec4f2f7
bump node build versin, top python version
bollwyvl Jan 22, 2023
c364f4c
update typescript deps
bollwyvl Jan 22, 2023
2a76e65
more tsconfig
bollwyvl Jan 22, 2023
8fc64bb
normalize build, actions
bollwyvl Jan 22, 2023
d6e8e83
normalize yarn/jlpm run and install
bollwyvl Jan 22, 2023
91b2cc4
update docs deps
bollwyvl Jan 22, 2023
15230bf
bump ui-test deps
bollwyvl Jan 22, 2023
36dcf3e
fix labextension invocation
bollwyvl Jan 22, 2023
34f8db2
lint yaml
bollwyvl Jan 22, 2023
2a368d2
add typedoc
bollwyvl Jan 22, 2023
28c0c4d
start reworking docs site structure and content
bollwyvl Jan 23, 2023
8e4edce
apply prettier to markdown
bollwyvl Jan 23, 2023
dbab210
prettier spec
bollwyvl Jan 23, 2023
5e6752f
hoist js api
bollwyvl Jan 23, 2023
6cf5756
restore yarn cache
bollwyvl Jan 23, 2023
659381b
more yarn cache
bollwyvl Jan 23, 2023
00d3b06
add jupyterlab-myst to binder
bollwyvl Jan 23, 2023
e275ea6
update screenshot
bollwyvl Jan 23, 2023
4880190
disable theme switcher for now
bollwyvl Jan 23, 2023
00bab81
normalize more yarn invocations, update another screenshot
bollwyvl Jan 23, 2023
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
1 change: 1 addition & 0 deletions .binder/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
bqplot
ipyleaflet
jupyterlab-myst
jupyterlab~=3.0
matplotlib
networkx
Expand Down
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,11 @@ Paste the output from your browser Javascript console here.
</details>

### If using JupyterLab

- JupyterLab version:

<details><summary>Installed Labextensions</summary>
<pre>
Paste the output from your command line running `jupyter labextension list`.
</pre>
</details>
</details>
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/custom_widget_issue.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
name: Custom Widget
about: Issues or questions related to developing a custom widget
labels: "Custom Widget"
labels: 'Custom Widget'
---

<!--
<!--
If this is a:

Bug Report: Please add the relevant pieces of information from the bug report template to this issue (https://github.com/jupyterlab/jupyterlab/issues/new?template=bug_report.md)

Question: Great! Thanks for asking here, since someone else will be able to find the answer more easily in the future. Please try to provide as much detail as you can about what you would like to accomplish and what you have tried.

Feature Request: Please follow the template from https://github.com/jupyterlab/jupyterlab/issues/new?template=feature_request.md
Feature Request: Please follow the template from https://github.com/jupyterlab/jupyterlab/issues/new?template=feature_request.md
-->
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ If you are referencing an existing piece of documentation or example please prov
* There is no example showing how to do [...]
-->


### Suggested Improvement

<!--
Expand Down
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ version: 2
# Ref https://github.com/dependabot/dependabot-core/issues/2521#issuecomment-863261500
updates:
- package-ecosystem: npm
directory: "/"
directory: '/'
schedule:
interval: "daily"
interval: 'daily'
open-pull-requests-limit: 0 # in case you don't want to enable version updates
allow:
- dependency-type: "production"
- dependency-type: 'production'
35 changes: 17 additions & 18 deletions .github/workflows/binder-on-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,25 @@ on:
types: [opened]

permissions:
pull-requests:
write
pull-requests: write

jobs:
binder:
runs-on: ubuntu-latest
steps:
- name: comment on PR with Binder link
uses: actions/github-script@v1
with:
github-token: ${{secrets.GITHUB_TOKEN}}
script: |
var PR_HEAD_USERREPO = process.env.PR_HEAD_USERREPO;
var PR_HEAD_REF = process.env.PR_HEAD_REF;
github.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/${PR_HEAD_USERREPO}/${PR_HEAD_REF}?urlpath=lab/tree/docs/source/examples/) :point_left: Launch a binder notebook on branch _${PR_HEAD_USERREPO}/${PR_HEAD_REF}_`
})
env:
PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
PR_HEAD_USERREPO: ${{ github.event.pull_request.head.repo.full_name }}
- name: comment on PR with Binder link
uses: actions/github-script@v6
with:
github-token: ${{secrets.GITHUB_TOKEN}}
script: |
var PR_HEAD_USERREPO = process.env.PR_HEAD_USERREPO;
var PR_HEAD_REF = process.env.PR_HEAD_REF;
github.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/${PR_HEAD_USERREPO}/${PR_HEAD_REF}?urlpath=lab/tree/docs/source/examples/) :point_left: Launch a binder notebook on branch _${PR_HEAD_USERREPO}/${PR_HEAD_REF}_`
})
env:
PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
PR_HEAD_USERREPO: ${{ github.event.pull_request.head.repo.full_name }}
102 changes: 63 additions & 39 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,42 +10,66 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v1
- name: Install node
uses: actions/setup-node@v3
with:
node-version: '14'
cache: 'yarn'
- name: Install Python
uses: actions/setup-python@v1
with:
python-version: '3.8'
architecture: 'x64'
- name: Cache pip on Linux
uses: actions/cache@v1
if: startsWith(runner.os, 'Linux')
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.python }}-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.python }}

- name: Install dependencies
run: |
python -m pip install jupyterlab~=3.0 jupyter_packaging~=0.10
- name: Build the extension
run: |
pushd python/ipywidgets
pip install .
popd
jlpm install
jlpm run build
pushd python/jupyterlab_widgets
pwd
pip install -e .
jupyter labextension develop . --overwrite
popd
jupyter labextension list

python -m jupyterlab.browser_check
- name: Checkout
uses: actions/checkout@v3

- name: Install node
uses: actions/setup-node@v3
with:
node-version: '18'
cache: yarn

- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.8'
architecture: 'x64'

- name: Cache pip on Linux
uses: actions/cache@v3
if: startsWith(runner.os, 'Linux')
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.python }}-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.python }}

- name: Install build dependencies
run: |
python -m pip install jupyterlab~=3.0 jupyter_packaging~=0.10

- name: Install node dependencies
run: |
jlpm

- name: Build node packages
run: |
jlpm build

- name: Install jupyterlab_widgets
run: |
cd python/jupyterlab_widgets
pip install -vv -e . --no-deps

- name: Install widgetsnbextension
run: |
cd python/widgetsnbextension
pip install -vv -e . --no-deps

- name: Install ipywidgets
run: |
cd python/ipywidgets
pip install -vv . --no-deps

- name: Install development extension
run: |
cd python/jupyterlab_widgets
jupyter labextension develop . --overwrite

- name: List labextensions
run: |
jupyter labextension list

- name: Run JupyterLab browser check
run: |
python -m jupyterlab.browser_check
58 changes: 29 additions & 29 deletions .github/workflows/devinstall.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,34 @@ jobs:
devinstall:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v1
- name: Install node
uses: actions/setup-node@v3
with:
node-version: '14'
cache: 'yarn'
- name: Install Python
uses: actions/setup-python@v1
with:
python-version: '3.8'
architecture: 'x64'
- name: Cache pip on Linux
uses: actions/cache@v1
if: startsWith(runner.os, 'Linux')
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.python }}-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.python }}
- name: Checkout
uses: actions/checkout@v3
- name: Install node
uses: actions/setup-node@v3
with:
node-version: '18'
cache: yarn
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.8'
architecture: 'x64'
- name: Cache pip on Linux
uses: actions/cache@v3
if: startsWith(runner.os, 'Linux')
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.python }}-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.python }}

- name: Install dependencies
run: |
python -m pip install notebook jupyterlab~=3.0 jupyter_packaging~=0.10
- name: Run the dev-install script
run: |
./dev-install.sh
jupyter nbextension list
jupyter labextension list
- name: Install dependencies
run: |
python -m pip install notebook jupyterlab~=3.0 jupyter_packaging~=0.10
- name: Run the dev-install script
run: |
./dev-install.sh
jupyter nbextension list
jupyter labextension list

python -m jupyterlab.browser_check
python -m jupyterlab.browser_check
22 changes: 11 additions & 11 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Install node
uses: actions/setup-node@v3
with:
node-version: '14'
cache: 'yarn'
- name: yarn install, integrity, lint
run: |
yarn install --frozen-lockfile
yarn run integrity
yarn run lint:check
- uses: actions/checkout@v3
- name: Install node
uses: actions/setup-node@v3
with:
node-version: '18'
cache: yarn
- name: yarn install, integrity, lint
run: |
yarn --frozen-lockfile
yarn integrity
yarn lint:check
Loading