some docs about latex, warm up cache

Author: bollwyvl

ci/job.test.yml

@@ -69,6 +69,9 @@ jobs:
               - script: ${{ platform.activate }} && python scripts/jedi_cache.py
                 displayName: warm up jedi cache
 
+              - script: ${{ platform.activate }} && python scripts/tectonic_cache.py
+                displayName: warm up tectonic cache
+
               - script: ${{ platform.activate }} && jlpm test
                 displayName: run frontend unit tests
 

docs/Installation.ipynb

@@ -8,15 +8,27 @@
    },
    "outputs": [],
    "source": [
-    "from markdown import markdown\n",
     "import sys\n",
-    "sys.path.insert(0, '..')\n",
+    "\n",
+    "from markdown import markdown\n",
+    "\n",
+    "sys.path.insert(0, \"..\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "hide_input": true
+   },
+   "outputs": [],
+   "source": [
     "from versions import (\n",
     "    JUPYTER_LSP_VERSION,\n",
     "    JUPYTERLAB_LSP_VERSION,\n",
     "    JUPYTERLAB_NEXT_MAJOR_VERSION,\n",
     "    JUPYTERLAB_VERSION,\n",
-    "    REQUIRED_JUPYTERLAB\n",
+    "    REQUIRED_JUPYTERLAB,\n",
     ")"
    ]
   },
@@ -85,7 +97,7 @@
     "#### conda (minimal python)\n",
     "\n",
     "```bash\n",
-    "conda create -c conda-forge -n lsp 'python >=3.7,<3.8' 'jupyterlab={JUPYTERLAB_VERSION}' 'nodejs>8' python-language-server\n",
+    "conda create -c conda-forge -n lsp 'python >=3.7,<3.8' 'jupyterlab={JUPYTERLAB_VERSION}' 'nodejs>10' python-language-server\n",
     "# Also consider: r-languageserver [*]\n",
     "source activate lsp\n",
     "python -m pip install 'jupyter-lsp={JUPYTER_LSP_VERSION}' --no-deps\n",
@@ -125,13 +137,15 @@
     "##### `Dockerfile`\n",
     "\n",
     "```dockerfile\n",
-    "# This already contains the python, r, julia, and nodejs runtimes\n",
+    "# This already contains the python, r, julia, latex, and nodejs runtimes\n",
     "FROM jupyter/datascience-notebook@sha256:73a577b006b496e1a1c02f5be432f4aab969c456881c4789e0df77c89a0a60c2\n",
     "\n",
-    "RUN conda install --quiet --yes --freeze-installed \\\n",
+    "RUN conda install --quiet --yes --freeze-installed -c conda-forge \\\n",
     "    'python-language-server' \\\n",
     "    'jupyterlab={JUPYTERLAB_VERSION}' \\\n",
     "    'r-languageserver' \\\n",
+    "    'texlab' \\\n",
+    "    'chktex' \\\n",
     "  && python3 -m pip install --no-cache-dir --no-deps \\\n",
     "    'jupyter-lsp={JUPYTER_LSP_VERSION}' \\\n",
     "  && jupyter labextension install --no-build \\\n",
@@ -285,7 +299,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.5"
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,

docs/Language Servers.ipynb

@@ -132,7 +132,7 @@
    },
    "outputs": [],
    "source": [
-    "nb_langs = [\"pyls\", \"r-languageserver\", \"texlab\"]\n",
+    "nb_langs = [\"pyls\", \"r-languageserver\"]\n",
     "lang_server_table(\n",
     "    {key: spec for key, spec in mgr.language_servers.items() if key in nb_langs}\n",
     ")"
@@ -199,6 +199,48 @@
     "install them with [extra_node_roots](./Configuring.ipynb#extra_node_roots)."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Other Scientific Languages\n",
+    "\n",
+    "These servers have been mostly tested with file editor."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "hide_input": true
+   },
+   "outputs": [],
+   "source": [
+    "sci_langs = [\"texlab\"]\n",
+    "lang_server_table(\n",
+    "    {key: spec for key, spec in mgr.language_servers.items() if key in sci_langs}\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Example: Getting a $\\LaTeX$ stack\n",
+    "\n",
+    "```bash\n",
+    "conda install -y conda-forge tectonic texlab chktex\n",
+    "```\n",
+    "\n",
+    "This will install:\n",
+    "\n",
+    "- `tectonic`, a cross-platform $\\LaTeX$ processing tool\n",
+    "  - note, it will download a large number of packages when first executed\n",
+    "- `texlab`, a Language Server for `.tex` files that supports completion and\n",
+    "  refernce navigation\n",
+    "- `chktex`, a `.tex` style checker"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

py_src/jupyter_lsp/specs/texlab.py

@@ -12,7 +12,7 @@ class Texlab(ShellSpec):
             home="https://texlab.netlify.app",
             issues="https://github.com/latex-lsp/texlab/issues",
         ),
-        install=dict(conda="conda install -c conda-forge texlab"),
+        install=dict(conda="conda install -c conda-forge texlab chktex"),
         config_schema=load_config_schema(key),
         env=dict(RUST_BACKTRACE="1"),
     )

scripts/tectonic_cache.py

@@ -0,0 +1,28 @@
+import subprocess
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+HERE = Path(__file__).parent
+EXAMPLE = HERE.parent / "atest/examples/example.tex"
+
+
+def tectonic_cache():
+    """ warm up the tectonic cache so that it doesn't fail the acceptance test
+    """
+    with TemporaryDirectory() as td:
+        tdp = Path(td)
+        tex = tdp / "example.tex"
+        tex.write_text(
+            "\n".join(
+                [
+                    line
+                    for line in EXAMPLE.read_text().splitlines()
+                    if "\\foo" not in line
+                ]
+            )
+        )
+        subprocess.check_call(["tectonic", str(tex)], cwd=td)
+
+
+if __name__ == "__main__":
+    tectonic_cache()