Skip to content

Commit f900f7a

Browse files
committed
update some tested install docs, make github skipping less janky
1 parent de13ae0 commit f900f7a

File tree

3 files changed

+38
-34
lines changed

3 files changed

+38
-34
lines changed

docs/Installation.ipynb

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,17 @@
5252
"conda create -c conda-forge -n lsp 'python >=3.7,<3.8' 'jupyterlab=1.2' 'nodejs=11' python-language-server\n",
5353
"# Also consider: r-languageserver [*]\n",
5454
"source activate lsp\n",
55-
"pip install jupyter_lsp=0.7 --no-deps\n",
56-
"jupyter lab build\n",
55+
"python -m pip install 'jupyter_lsp=0.7' --no-deps\n",
56+
"jupyter labextension install '@krassowski/[email protected]'\n",
57+
"```\n",
58+
"\n",
59+
"Then run\n",
60+
"\n",
61+
"```bash\n",
5762
"jupyter lab\n",
58-
"```"
63+
"```\n",
64+
"\n",
65+
"Your browser should open to your local server."
5966
]
6067
},
6168
{
@@ -65,7 +72,9 @@
6572
"#### docker (data science)\n",
6673
"\n",
6774
"This approach is based roughly on the\n",
68-
"[Jupyter docker-stacks documentation](https://github.com/jupyter/docker-stacks/tree/master/examples/docker-compose/notebook)."
75+
"[Jupyter docker-stacks documentation](https://github.com/jupyter/docker-stacks/tree/master/examples/docker-compose/notebook),\n",
76+
"which should be consulted for more about connecting volumes, passwords, and\n",
77+
"other advanced features:"
6978
]
7079
},
7180
{
@@ -75,21 +84,23 @@
7584
"##### `Dockerfile`\n",
7685
"\n",
7786
"```dockerfile\n",
78-
"FROM jupyter/datascience-notebook:18ef2702c6a2\n",
87+
"# This already contains the python, r, julia, and nodejs runtimes as well as jupyterlab 1.25\n",
88+
"FROM jupyter/datascience-notebook@sha256:73a577b006b496e1a1c02f5be432f4aab969c456881c4789e0df77c89a0a60c2\n",
7989
"\n",
8090
"RUN conda install --quiet --yes --freeze-installed \\\n",
81-
" 'jupyterlab=1.2' \\\n",
82-
" 'nodejs=11' \\\n",
83-
" 'python-language-server' \\\n",
84-
" 'r-languageserver' \\\n",
85-
" && pip install \\\n",
86-
" 'jupyter_lsp=0.7' \\\n",
87-
" && conda clean --all -f -y \\\n",
88-
" && fix-permissions \"$CONDA_DIR\" \\\n",
89-
" && fix-permissions \"/home/$NB_USER\" \\\n",
90-
" && jupyter lab build \\\n",
91-
" && jlpm cache clean \\\n",
92-
" && rm -rf \"$CONDA_DIR/share/jupyter/lab/{staging}\"\n",
91+
" 'python-language-server' \\\n",
92+
" 'r-languageserver' \\\n",
93+
" && python3 -m pip install --no-cache-dir --no-deps \\\n",
94+
" 'jupyter_lsp==0.7' \\\n",
95+
" && jupyter labextension install --no-build \\\n",
96+
" '@krassowski/[email protected]' \\\n",
97+
" && jupyter lab build --dev-build=False --minimize=True \\\n",
98+
" && conda clean --all -f -y \\\n",
99+
" && rm -rf \\\n",
100+
" $CONDA_DIR/share/jupyter/lab/staging \\\n",
101+
" /home/$NB_USER/.cache/yarn \\\n",
102+
" && fix-permissions $CONDA_DIR \\\n",
103+
" && fix-permissions /home/$NB_USER\n",
93104
"```"
94105
]
95106
},
@@ -103,22 +114,10 @@
103114
"version: '2'\n",
104115
"\n",
105116
"services:\n",
106-
" notebook:\n",
117+
" lsp-lab:\n",
107118
" build: .\n",
108-
" image: jupyterlab-lsp-notebook\n",
109-
" container_name: ${NAME}\n",
110-
" volumes:\n",
111-
" - 'work:/home/jovyan/work'\n",
112119
" ports:\n",
113-
" - '${PORT}:8888'\n",
114-
" environment:\n",
115-
" USE_HTTPS: 'yes'\n",
116-
" PASSWORD: ${PASSWORD}\n",
117-
"\n",
118-
"volumes:\n",
119-
" work:\n",
120-
" external:\n",
121-
" name: ${WORK_VOLUME}\n",
120+
" - '18888:8888'\n",
122121
"```"
123122
]
124123
},
@@ -129,8 +128,11 @@
129128
"##### Build and Start\n",
130129
"\n",
131130
"```bash\n",
132-
"PORT=8899 NAME=lsp PASSWORD=change-me-silly WORK_VOLUME=. docker-compose up\n",
133-
"```"
131+
"docker-compose up\n",
132+
"```\n",
133+
"\n",
134+
"You should now be able to access `http://localhost:18888/lab`, using the `token`\n",
135+
"provided in the log."
134136
]
135137
},
136138
{

docs/_templates/breadcrumbs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
{% endblock %}
3737
{% block breadcrumbs_aside %}
3838
<li class="wy-breadcrumbs-aside">
39-
{% if hasdoc(pagename) and pagename not in ["search", "genindex"] %}
39+
{% if hasdoc(pagename) and pagename not in hide_github_pagenames %}
4040
{% if display_github %}
4141
{% if check_meta and 'github_url' in meta %}
4242
<!-- User defined GitHub URL -->

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@
9292

9393
html_context = {
9494
"display_github": True,
95+
# these automatically-generated pages will create broken links
96+
"hide_github_pagenames": ["search", "genindex"],
9597
"github_user": github_repo_org,
9698
"github_repo": github_repo_name,
9799
"github_version": "master",

0 commit comments

Comments
 (0)