Skip to content

Commit

Permalink
🔧 Moving the Data Science content into Python4DataScience
Browse files Browse the repository at this point in the history
* /first-steps/index.html -> /notebook/index.html
* /first-steps/create-notebook.html -> /notebook/create-notebook.html
* /first-steps/install.html -> /notebook/install.html
* /workspace/jupyter/$rest -> /
* /workspace/first-steps/$rest -> /notebook/
* /workspace/ipython/$rest -> Python4DataScience:/workspace/ipython/
* /workspace/numpy/$rest -> Python4DataScience:/workspace/numpy/
* /workspace/pandas/$rest -> Python4DataScience:/workspace/pandas/
* /data-processing/$rest -> Python4DataScience:/data-processing/
* /clean-prep/$rest -> Python4DataScience:/clean-prep/
* /parameterise/$rest -> /notebook/parameterise/
* /performance/ipyparallel//$rest -> /hub/ipyparallel/
* /performance/ipython-profiler.html -> /notebook/ipython-profiler.html
* /performance/ -> Python4DataScience:/performance/
* /productive/ -> Python4DataScience:/productive/
* /testing/$rest ->  /notebook/testing/
* /web/dashboards/$rest ->  /dashboards/
  • Loading branch information
veit committed Jun 10, 2023
1 parent ca98359 commit 61c38ea
Show file tree
Hide file tree
Showing 134 changed files with 3,721 additions and 455 deletions.
44 changes: 12 additions & 32 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,10 @@
"https://python-basics-tutorial.readthedocs.io/en/latest/",
None,
),
"python4datascience": (
"https://python4datascience.readthedocs.io/en/latest/",
None,
),
}


Expand Down
File renamed without changes.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The server can be configured with the following three options:
setting: ``True``.

You can find more information about the server configuration in
:doc:`/workspace/jupyter/notebook/config`.
:doc:`/notebook/config`.

Client-side configuration
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
7 changes: 3 additions & 4 deletions docs/web/dashboards/index.rst → docs/dashboards/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ Dashboards
etc.) can be arranged in a design grid or in report form.
:doc:`appmode/index`
Jupyter extension that turns notebooks into web applications.
:doc:`/workspace/jupyter/nbviewer`
:doc:`/nbviewer`
It's great for viewing static reports, but it can also be used in
conjunction with :doc:`interaktiven Widgets
</workspace/jupyter/ipywidgets/embedding>`.
conjunction with :doc:`interaktiven Widgets </ipywidgets/embedding>`.
:doc:`panel/index`
was developed on the basis of `Bokeh <https://docs.bokeh.org/>`_
and `Param <https://github.com/holoviz/param>`_ and offers a toolkit
Expand Down Expand Up @@ -46,7 +45,7 @@ of the various libraries.

jupyter-dashboards/index
appmode/index
/workspace/jupyter/nbviewer
../nbviewer
panel/index
voila/index
jupyter-flex/index
File renamed without changes.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Jupyter extension that turns notebooks into dashboards:
* uses Markdown headers and Jupyter notebook cell tags to define the layout and
components of the dashboard
* flexible and easy way to define row- and column-oriented layouts
* uses :doc:`/workspace/jupyter/nbconvert` for static reports
* uses :doc:`/nbconvert` for static reports
* uses :doc:`../voila/index` for dynamic applications with a Jupyter
:doc:`/workspace/jupyter/kernels/index`
* :doc:`/workspace/jupyter/ipywidgets/index` support
:doc:`/kernels/index`
* :doc:`/ipywidgets/index` support

.. seealso::
* `Docs <https://jupyter-flex.extrapolations.dev/>`_
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ Voilà
Features
--------

* Voilà supports :doc:`interactive Jupyter widgets
</workspace/jupyter/ipywidgets/index>`, including round trips to the kernel.
* Voilà supports :doc:`interactive Jupyter widgets </ipywidgets/index>`,
including round trips to the kernel.
Custom widgets like :doc:`pyviz:d3js/bqplot/index`,
:doc:`pyviz:js/ipyleaflet`,
:doc:`pyviz:js/ipyvolume`,
`ipympl <https://github.com/matplotlib/ipympl>`_,
:doc:`ipysheet </workspace/jupyter/ipywidgets/libs/ipysheet>`,
:doc:`ipysheet </ipywidgets/libs/ipysheet>`,
`plotly <https://github.com/plotly/plotly.py>`_,
`ipywebrtc <https://github.com/maartenbreddels/ipywebrtc>`_ etc. are also
supported.
* Voilà does not allow arbitrary code execution by dashboard users.
* Voilà is based on Jupyter standard protocols and file formats and works with
any :doc:`Jupyter-Kernel </workspace/jupyter/kernels/index>`: C++, Python,
Julia. This makes it a language-independent dashboard system.
any :doc:`Jupyter-Kernel </kernels/index>`: C++, Python, Julia. This makes it
a language-independent dashboard system.
* Voilà is expandable. It contains a flexible :doc:`Template <templating>`
system for creating extensive layouts.

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ A Voilà template is a folder that is located in the virtual environment at
{"base_template": "default"}
``nbconvert_templates``
Custom templates for nbconvert :doc:`/workspace/jupyter/nbconvert`.
Custom templates for nbconvert :doc:`/nbconvert`.
``static``
Directory for static files.
``templates``
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
16 changes: 0 additions & 16 deletions docs/first-steps/index.rst

This file was deleted.

104 changes: 0 additions & 104 deletions docs/first-steps/install.rst

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ Jupyter Notebooks and which acts as a proxy.
config
systemdspawner
nbviewer-service
ipyparallel/index
File renamed without changes.

0 comments on commit 61c38ea

Please sign in to comment.