Merge pull request #44 from MetOs-UiO/remove-placeholders

Remove notebook placeholder, add links.
MetOs-UiO · May 7, 2024 · ba74794 · ba74794
2 parents 142178f + b5b370a
commit ba74794
Show file tree

Hide file tree

Showing 10 changed files with 59 additions and 34 deletions.
diff --git a/docs/basics/img/bug-button.png b/docs/basics/img/bug-button.png
diff --git a/docs/basics/img/bug-tab.png b/docs/basics/img/bug-tab.png
diff --git a/docs/basics/img/hidden-files.png b/docs/basics/img/hidden-files.png
diff --git a/docs/basics/img/sett-editor-cont.png b/docs/basics/img/sett-editor-cont.png
diff --git a/docs/basics/img/sett-editor.png b/docs/basics/img/sett-editor.png
diff --git a/docs/basics/index.rst b/docs/basics/index.rst
@@ -7,4 +7,5 @@ Jupyterhub basic usage
 
    start_stop
    lab
-   kernels
+   kernels
+   settings
diff --git a/docs/basics/lab.rst b/docs/basics/lab.rst
@@ -55,3 +55,20 @@ By default, your new notebook is named as "**Untitled.ipynb**":
 - **ipynb** is the extension for any Jupyter notebook and you should make sure all your notebooks get this extension (otherwise it is not recognized as a Jupyter notebook)
 - you can rename your jupyter notebook with the tab "File --> Rename Notebook..." or
   right click on its name.
+
+Using debugger
+~~~~~~~~~~~~~~
+
+If you want to see the list variables, their values, function callbacks, sett breakpoints. You can eneable a debugger in your notebook.
+
+To do that: click on the little bug button in the headder of your. Where kernels, play etc is lockated:
+
+.. image:: img/bug-button.png
+   :width: 600
+   :alt: bug button
+
+When you click on it, it will change its color to orange and the debugger panel on the right will open. You can always collapse the panel and expand it back.
+
+.. image:: img/bug-tab.png
+   :width: 600
+   :alt: bug tab
diff --git a/docs/basics/settings.rst b/docs/basics/settings.rst
@@ -0,0 +1,38 @@
+JupyterLab settings
+~~~~~~~~~~~~~~~~~~~
+
+If you want to change some JupyterLab settings. You can o into **Settings** -\> **Settings Editor**.
+
+
+.. image:: img/sett-editor.png
+   :width: 400
+   :alt: Settings
+
+
+There, you will see settings that control JupyterLab extensions and looks.
+
+
+.. image:: img/sett-editor-cont.png
+   :width: 600
+   :alt: Settings Editor
+
+
+Here, for example, you can change the visibility of hidden files (the ones that start with the ``.`` in linux).
+
+
+.. image:: img/hidden-files.png
+   :width: 600
+   :alt: Hidden Files
+
+
+
+
+Styling warnings in notebooks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On the Jupyterhub, we are using ``pylsp`` as a language-server for linting, styling, formatting and other features.
+
+If you are annoyed by ``~~~~~~`` wigly lines, you can disable some of them by ignoring them when ``pylsp`` compares your code to `PEP8 style convention <https://peps.python.org/pep-0008/>`_.
+You can check the error codes `here <https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes>`_.
+
+To do that. You can go to the file ``~/.config/pycodestyle`` and add the error codes you do not like to the ignore list.
diff --git a/docs/learning/notebooks/cool_stuff.ipynb b/docs/learning/notebooks/cool_stuff.ipynb
diff --git a/docs/learning/us-links.rst b/docs/learning/us-links.rst
@@ -9,6 +9,8 @@ Some useful links
 - `Intake-ESM <https://intake-esm.readthedocs.io/en/stable/>`_
 - `ACTRIS and EBAS example notebooks <https://github.com/ACTRIS-Data-Centre/actris-jupyter-hub>`_
 
+- `CMOR variable tables <https://github.com/PCMDI/cmip6-cmor-tables/blob/main/Tables/CMIP6_fx.json>`_ or `web-form <https://clipc-services.ceda.ac.uk/dreq/mipVars.html>`_
+