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

Add files for JupyterLite #45

Merged
merged 41 commits into from
Dec 6, 2022
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
9746f9b
Add files for ReadTheDocs
jtpio Aug 5, 2022
50ef4f0
Add config
jtpio Aug 5, 2022
fa84108
Add build to dependencies
jtpio Aug 5, 2022
30acded
Fix manifest and index
jtpio Aug 5, 2022
8aa0b0f
Add dedicated index for the docs
jtpio Aug 5, 2022
15529ad
Fix check-manifest
jtpio Aug 5, 2022
69b59e8
Update to the latest jupyterlite
jtpio Nov 17, 2022
6ac0067
Add `nodejs` to the docs environment
jtpio Nov 17, 2022
2793fe8
Remove `ignore_sys_prefix`
jtpio Nov 17, 2022
4dfc4cf
Cleanup config and remove xeus kernel
jtpio Nov 18, 2022
705fb47
Add example file
jtpio Nov 18, 2022
54c06b7
Ignore docs/content for prettier
jtpio Nov 18, 2022
bda05cb
Add `docs/content` to eslintignore
jtpio Nov 18, 2022
f970d15
Run black on conf.py
jtpio Nov 18, 2022
8716b15
Populate docs/index.md
jtpio Nov 18, 2022
811ad2e
Simplify example.js
jtpio Nov 18, 2022
af44b45
Remove extra title
jtpio Nov 18, 2022
6e5c3e9
Add `extra_file_types`
jtpio Nov 23, 2022
1a36704
Rename to example.ts
jtpio Nov 23, 2022
d6f2146
Update example content
jtpio Nov 23, 2022
1272212
Update link in docs index
jtpio Nov 23, 2022
a4bd702
Update `check-release` action
jtpio Nov 23, 2022
025fe66
Skip `check-links` for now
jtpio Nov 23, 2022
0a3d877
Add `check_links` job
jtpio Nov 23, 2022
9351b63
Try fixing ignore_glob
jtpio Nov 23, 2022
91a8af0
Try fixing ignore_glob
jtpio Nov 23, 2022
33a8e83
fix
jtpio Nov 23, 2022
87061b3
Try ignore_links
jtpio Nov 23, 2022
616151a
fix
jtpio Nov 23, 2022
4ee7b9d
fix
jtpio Nov 23, 2022
47b0c47
Fix eof
jtpio Nov 23, 2022
cce4489
fix ignore_links
jtpio Nov 23, 2022
cbd17f0
Add hint
jtpio Nov 24, 2022
d79acff
try without the badge
jtpio Nov 24, 2022
60c5193
try
jtpio Nov 24, 2022
ae65e5f
undo
jtpio Nov 24, 2022
29755f9
try
jtpio Nov 24, 2022
a66a5d1
one last try
jtpio Nov 24, 2022
ea6f13f
Add JupyterLite badge to the README
jtpio Dec 6, 2022
6d53846
Add `sphinxext.rediraffe`
jtpio Dec 6, 2022
aa39dd6
Remove `sphinxext.rediraffe`
jtpio Dec 6, 2022
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
12 changes: 12 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 2

build:
os: "ubuntu-20.04"
tools:
python: "mambaforge-4.10"

conda:
environment: docs/environment.yml

sphinx:
configuration: docs/conf.py
43 changes: 43 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# -*- coding: utf-8 -*-
jtpio marked this conversation as resolved.
Show resolved Hide resolved
extensions = [
'myst_parser',
'jupyterlite_sphinx'
]

jupyterlite_config = "jupyter_lite_config.json"
jupyterlite_dir = "."
jupyterlite_contents = "content"
jtpio marked this conversation as resolved.
Show resolved Hide resolved

master_doc = 'index'
source_suffix = '.md'

# General information about the project.
project = 'JupyterLab Plugin Playground'
author = 'Project Jupyter'

exclude_patterns = []
highlight_language = 'python'
pygments_style = 'sphinx'

html_theme = "pydata_sphinx_theme"
html_static_path = ['_static']

html_css_files = [
'custom.css'
]


def on_config_inited(*args):
import sys
import subprocess
from pathlib import Path
HERE = Path(__file__)
ROOT = HERE.parent.parent
subprocess.check_call(["jlpm"], cwd=str(ROOT))
subprocess.check_call(["jlpm", "build"], cwd=str(ROOT))

subprocess.check_call([sys.executable, "-m", "build"], cwd=str(ROOT))


def setup(app):
app.connect("config-inited", on_config_inited)
21 changes: 21 additions & 0 deletions docs/environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: jupyterlab-plugin-playground-lite

channels:
- conda-forge

dependencies:
- build
- python=3.10
- mamba
- pydata-sphinx-theme
- myst-parser
- empack
jtpio marked this conversation as resolved.
Show resolved Hide resolved
- ipywidgets>=7.7,<8
jtpio marked this conversation as resolved.
Show resolved Hide resolved
- jupyterlab>=3.4.3,<4
- jupyterlab-language-pack-fr-FR
- jupyterlab-language-pack-zh-CN
- nodejs=16
jtpio marked this conversation as resolved.
Show resolved Hide resolved
- pip:
- jupyterlite-sphinx
- jupyterlite-xeus-python>=0.5
- jupyterlite==0.1.0b14
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# JupyterLab Plugin Playground
jtpio marked this conversation as resolved.
Show resolved Hide resolved
10 changes: 10 additions & 0 deletions docs/jupyter-lite.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"jupyter-lite-schema-version": 0,
"jupyter-config-data": {
"appName": "JupyterLab Plugin Playground",
"disabledExtensions": [
"@jupyterlite/javascript-kernel-extension",
jtpio marked this conversation as resolved.
Show resolved Hide resolved
"@jupyterlite/pyolite-kernel-extension"
]
}
}
11 changes: 11 additions & 0 deletions docs/jupyter_lite_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

{
"LiteBuildConfig": {
"federated_extensions": [
"../jupyterlab_plugin_playground/labextension"
],
"piplite_urls": [
"../dist"
jtpio marked this conversation as resolved.
Show resolved Hide resolved
]
}
}
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ build_cmd = "build:prod"
npm = ["jlpm"]

[tool.check-manifest]
ignore = ["jupyterlab_plugin_playground/labextension/**", "yarn.lock", ".*", "package-lock.json", "scripts/**"]
ignore = ["docs/**", "jupyterlab_plugin_playground/labextension/**", "yarn.lock", ".*", "package-lock.json", "scripts/**"]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe break up into lines and sort

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also add link to docs in the setup.py

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hoping to do more cleanups in #51