🔧 Moving the Data Science content into Python4DataScience

* /docs/first-steps/index.html -> /notebook/index.html * /docs/first-steps/create-notebook.html -> /notebook/create-notebook.html * /docs/first-steps/install.html -> /notebook/install.html * /docs/workspace/jupyter/$rest -> / * /docs/workspace/first-steps/$rest -> /notebook/ * /docs/workspace/ipython/$rest -> Python4DataScience/docs/workspace/ipython/ * /docs/workspace/numpy/$rest -> Python4DataScience/docs/workspace/numpy/ * /docs/workspace/pandas/$rest -> Python4DataScience/docs/workspace/pandas/ * docs/data-processing/ * docs/clean-prep * docs/performance/perflint.rst -> Python4DataScience/docs/performance/ * docs/performance/parallelise-pandas.rst -> Python4DataScience/docs/performance/ * docs/performance/dask.ipynb -> Python4DataScience/docs/performance/ * docs/performance/multiprocessing-threading-async.rst -> Python4DataScience/docs/performance/ * docs/performance/threading-example.ipynb -> Python4DataScience/docs/performance/ * docs/performance/multiprocessing.ipynb -> Python4DataScience/docs/performance/ * docs/performance/threading-forking-combined.ipynb -> Python4DataScience/docs/performance/ * docs/performance/asyncio-example.ipynb -> Python4DataScience/docs/performance/ * docs/productive/ -> Python4DataScience/docs/productive/
veit · Jun 8, 2023 · 486ec6f · 486ec6f
1 parent 74ed37b
commit 486ec6f
Show file tree

Hide file tree

Showing 59 changed files with 235 additions and 389 deletions.
diff --git a/README.rst b/README.rst
@@ -44,46 +44,30 @@ Installation
        creating: jupyter-tutorial-main/
     …
 
-#. Edit the ``Pipfile`` in the unpacked archive and enter your current Python version in this section:
-
-  .. code-block:: console
-
-    [requires]
-    python_version = ""
-
-#. Install Pipenv
-
-   Refer to :doc:`Install Pipenv </productive/envs/pipenv/install>`
-
 #. Install Python packages:
 
    .. code-block:: console
 
     $ cd jupyter-tutorial-main
-    $ pipenv install
-    Creating a virtualenv for this project…
-    …
-    Installing dependencies from Pipfile.lock (fbb457)…
-    …
-    $ pipenv run jupyter nbextension enable highlighter/highlighter
-        Enabling notebook extension highlighter/highlighter...
-              - Validating: OK
+    $ python3 -m venv .
+    $ . bin/activate
+    $ python -m pip install -r docs/requirements.txt
 
 #. Install the `Jupyter Notebook Extensions
    <https://jupyter-contrib-nbextensions.readthedocs.io/>`_ Javascript and CSS
    files:
 
    .. code-block:: console
 
-    $ pipenv run jupyter contrib nbextension install --user
+    $ jupyter contrib nbextension install --user
     jupyter contrib nbextension install --user
     Installing jupyter_contrib_nbextensions nbextension files to jupyter data directory
     …
     Successfully installed jupyter-contrib-core-0.3.3 jupyter-contrib-nbextensions-0.5.1
     jupyter-highlight-selected-word-0.2.0 jupyter-latex-envs-1.4.6
     jupyter-nbextensions-configurator-0.4.1
     …
-    $ pipenv run jupyter nbextension enable latex_envs --user --py
+    $ jupyter nbextension enable latex_envs --user --py
     Enabling notebook extension latex_envs/latex_envs...
           - Validating: OK
 
@@ -93,16 +77,14 @@ Installation
 
    .. code-block:: console
 
-    $  sudo apt-get install pandoc
+    $  sudo apt install pandoc
 
-    To create the HTML documentation run these commands:
+   To create the HTML documentation run these commands:
 
    .. code-block:: console
 
-    $ python3 -m venv .
-    $ bin/python -m pip install --upgrade pip
-    $ bin/python -m pip install -r docs/constraints.txt
-    $ bin/sphinx-build -ab html docs/ docs/_build/
+    $ cd docs/
+    $ make html
 
 #. Create a PDF:
 
@@ -112,7 +94,7 @@ Installation
 
    .. code-block:: console
 
-    $ sudo apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk
+    $ sudo apt install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk
 
    or for macOS with:
 
@@ -131,8 +113,7 @@ Installation
 
    .. code-block:: console
 
-    $ cd docs/
-    $ pipenv run make latexpdf
+    $ make latexpdf
     …
     The LaTeX files are in _build/latex.
     Run 'make' in that directory to run these through (pdf)latex
@@ -162,8 +143,7 @@ Installation
 
    .. code-block:: console
 
-    $ cd jupyter-tutorial
-    $ vale docs/
+    $ vale .
     ✔ 0 errors, 0 warnings and 0 suggestions in 201 files.
 
 .. _follow-us:

diff --git a/docs/conf.py b/docs/conf.py
@@ -161,6 +161,10 @@
         "https://python-basics-tutorial.readthedocs.io/en/latest/",
         None,
     ),
+    "python4datascience": (
+        "https://python4datascience.readthedocs.io/en/latest/",
+        None,
+    ),
 }
 
 

diff --git a/docs/first-steps/index.rst b/docs/first-steps/index.rst
diff --git a/docs/first-steps/install.rst b/docs/first-steps/install.rst
diff --git a/docs/workspace/jupyter/hub/config.rst → docs/hub/config.rst b/docs/workspace/jupyter/hub/config.rst → docs/hub/config.rst
diff --git a/docs/workspace/jupyter/hub/index.rst → docs/hub/index.rst b/docs/workspace/jupyter/hub/index.rst → docs/hub/index.rst
diff --git a/docs/workspace/jupyter/hub/install.rst → docs/hub/install.rst b/docs/workspace/jupyter/hub/install.rst → docs/hub/install.rst
diff --git a/...orkspace/jupyter/hub/nbviewer-service.rst → docs/hub/nbviewer-service.rst b/...orkspace/jupyter/hub/nbviewer-service.rst → docs/hub/nbviewer-service.rst
diff --git a/.../workspace/jupyter/hub/systemdspawner.rst → docs/hub/systemdspawner.rst b/.../workspace/jupyter/hub/systemdspawner.rst → docs/hub/systemdspawner.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,14 +9,121 @@ innovations enormously and as well they make the entire research process faster
 and more reliable. In addition, many additional components are created that
 expand the original limits of their use and enable new uses.
 
+.. graphviz::
+
+    digraph decide_jupyter {
+        graph [fontname = "Calibri", fontsize="16"];
+        node [fontname = "Calibri", fontsize="16"];
+        edge [fontname = "Calibri", fontsize="16"];
+        tooltip="How do I decide which Jupyter packages I need?";
+        // Top Level
+        what [
+            shape=diamond,
+            label="What do you want to do?",
+            tooltip="Jupyter offers you different ways how you can use the notebooks"]
+        // Second Level
+        jupyter [
+            label="Jupyter\nNotebook",
+            tooltip="Install Jupyter locally",
+            target="_top",
+            href="../notebook/index.html"]
+        hub [
+            label="JupyterHub",
+            tooltip="Install\nJupyterHub",
+            target="_top",
+            href="../hub/index.html"]
+        nbconvert [
+            label="nbconvert",
+            tooltip="Install and\nuse nbconvert",
+            target="_top",
+            href="../nbconvert.html"]
+        nbviewer [
+            label="nbviewer",
+            tooltip="Install and\nuse nbviewer",
+            target="_top",
+            href="../nbviewer.html"]
+        kernels [
+            label="Kernels",
+            tooltip="Install, view and\nstart kernels",
+            target="_top",
+            href="../kernels/install.html"]
+        extensions [
+            shape=plaintext,
+            label=" ",
+            tooltip="Install notebook extensions"]
+        embed [
+            shape=plaintext,
+            label="",
+            tooltip="Embed notebooks in other applications"]
+        examples [
+            label="Enterprise\napplications",
+            tooltip="Application examples at\nNetflix, Bloomberg etc.",
+            target="_top",
+            href="../use-cases.html"]
+        // 3rd Level
+        widgets [
+            label="Widgets",
+            tooltip="Install and\nuse ipywidgets",
+            target="_top",
+            href="../ipywidgets/index.html"]
+        extend [
+            label="nbextensions",
+            tooltip="Install and use various\nnotebook extensions",
+            target="_top",
+            href="../nbextensions/index.html"]
+        viz [
+            label="Visualisation",
+            tooltip="Data visualisation libraries",
+            target="_top",
+            href="../viz/index.html"]
+        dash [
+            label="Dashboards",
+            tooltip="Install and\nuse Dashboards",
+            target="_top",
+            href="../web/dashboards/index.html"]
+        html [
+            label="HTML",
+            tooltip="Embed notebooks in\nstatic HTML",
+            target="_top",
+            href="../ipywidgets/embedding.html"]
+        sphinx [
+            label="Sphinx",
+            tooltip="Embed notebooks in the\nSphinx Document Generator",
+            target="_top",
+            href="../nbsphinx.html"]
+        // Edges
+        what -> jupyter [label="Single\nuser"]
+        what -> hub [label="Teamwork"]
+        what -> nbconvert [label="Convert"]
+        nbconvert -> nbviewer [label="Conversion\nservice"]
+        what -> kernels [label="Java, R,\nJulia etc."]
+        what -> extensions [label="Extend\nNotebook"]
+        what -> embed [label="Embed\nNotebooks"]
+        what -> examples [label="Examples"]
+        extensions -> {widgets extend viz dash}
+        embed -> {html sphinx} [label="Embed"]
+        // Arrangement
+        {rank = same; what;}
+        {rank = same; jupyter; hub; nbconvert; kernels; extensions; embed; examples;}
+        {rank = same; widgets; extend; viz; dash;}
+        {rank = same; html; sphinx}
+    }
+
 .. toctree::
     :hidden:
     :titlesonly:
     :maxdepth: 0
 
     intro
-    first-steps/index
-    workspace/index
+    notebook/index
+    hub/index
+    nbconvert
+    nbviewer
+    kernels/index
+    ipywidgets/index
+    nbextensions/index
+    nbsphinx
+    use-cases
     data-processing/index
     clean-prep/index
     viz/index