Erste Schritte

Schnelleinstieg

Contributors License Docs

Installation

  1. Herunterladen und Auspacken:

    $ curl -O https://github.com/veit/jupyter-tutorial/archive/master.zip
    $ unzip master.zip
    
  2. Pipenv installieren

    Siehe Pipenv installieren

  3. Python-Pakete installieren:

    $ cd jupyter-tutorial
    $ 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
    
  4. nbextension installieren und aktivieren:

    $ pipenv run jupyter nbextension install --py latex_envs --user
    
    $ pipenv run jupyter nbextension enable latex_envs --user --py
    Enabling notebook extension latex_envs/latex_envs...
          - Validating: OK
    
  5. HTML-Dokumentation erstellen:

    $ pipenv run sphinx-build -b html docs/ docs/_build/
    
  6. PDF erstellen:

    $ cd docs/
    $ pipenv run make latexpdf
    
    The LaTeX files are in _build/latex.
    Run 'make' in that directory to run these through (pdf)latex
    
    

    Das PDF findet ihr anschließend in docs/_build/latex/jupytertutorial.pdf.

Pull-Requests

Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehle ich euch, mit einen Fork eure eigene Version zu erstellen. Ich akzeptiere auch Pull-Requests, wenn diese klein und atomar sind sowie meine eigene Erfahrung verbessern.