├── .gitignore ├── README.md ├── docs ├── install.rst ├── index.rst ├── what_is_jupyter.rst ├── execute.rst ├── Makefile ├── make.bat └── conf.py └── Build Docs.ipynb /.gitignore: -------------------------------------------------------------------------------- 1 | .ipynb_checkpoints/* 2 | docs/html/* 3 | docs/_build/* 4 | 5 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Jupyter/IPython Notebook Quick Start Guide 2 | 3 | A quick-start guide to install and run Jupyter/IPython notebooks 4 | for absolute (python) beginners. 5 | 6 | [Read online](http://jupyter-notebook-beginner-guide.readthedocs.org/). 7 | -------------------------------------------------------------------------------- /docs/install.rst: -------------------------------------------------------------------------------- 1 | Installation 2 | ============ 3 | 4 | Step 0: The browser 5 | ------------------- 6 | 7 | Step "zero" consists in installing a modern standard-compliant browser. Either 8 | Mozilla Firefox or Google Chrome will work well. Try to avoid 9 | MS Explorer. 10 | 11 | Step 1: Installation 12 | -------------------- 13 | 14 | The easiest way to install the *Jupyter Notebook App* is 15 | installing a scientific python distribution which also includes 16 | scientific python packages. The most common distribution is called **Anaconda**: 17 | 18 | - Download `Anaconda Distribution `_ 19 | (a few 100MB), Python 3, 64 bits. 20 | 21 | - Install it using the default settings for a *single user*. 22 | 23 | *Official docs:* `Installation: If you are new to Python and Jupyter `__. 24 | 25 | .... 26 | 27 | The *Next* button will bring you to the next section (*Running Jupyter Notebook*). 28 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. Jupyter/IPython Notebook Quick Start Guide documentation master file, created by 2 | sphinx-quickstart on Sat Jun 13 10:59:36 2015. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Jupyter/IPython Notebook Quick Start Guide 7 | ========================================== 8 | 9 | This document is a brief step-by-step tutorial on installing and running 10 | Jupyter (IPython) notebooks on local computer for new users who have no familiarity with python. 11 | 12 | Briefly, if someone gave you a notebook to run and you don't know what 13 | a notebook is, this document is for you. 14 | 15 | **Jupyter Notebook App** (formerly **IPython Notebook**) is 16 | an application running inside the browser. 17 | This guide describes how to install and use *Jupyter Notebook App* 18 | as normal desktop application, without using any remote server. 19 | 20 | For other use-cases, please refer to the `Official Jupyter Documentation `__. 21 | 22 | 23 | Contents 24 | -------- 25 | 26 | .. toctree:: 27 | :maxdepth: 1 28 | :numbered: 29 | 30 | what_is_jupyter 31 | install 32 | execute 33 | 34 | The *Next* button will bring you to the first item in the tables of content (*What is Jupyter Notebook*). 35 | 36 | -------------------------------------------------------------------------------- /Build Docs.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "cell_type": "markdown", 5 | "metadata": {}, 6 | "source": [ 7 | "# Build Documentation\n", 8 | "\n", 9 | "This notebook is just a convenience to build the Sphinx documentation." 10 | ] 11 | }, 12 | { 13 | "cell_type": "code", 14 | "execution_count": null, 15 | "metadata": { 16 | "collapsed": false 17 | }, 18 | "outputs": [], 19 | "source": [ 20 | "!sphinx-build -b html \"docs\" \"docs/html/\"" 21 | ] 22 | }, 23 | { 24 | "cell_type": "markdown", 25 | "metadata": {}, 26 | "source": [ 27 | "View the generated [documentation](docs/html/index.html)." 28 | ] 29 | }, 30 | { 31 | "cell_type": "code", 32 | "execution_count": null, 33 | "metadata": { 34 | "collapsed": true 35 | }, 36 | "outputs": [], 37 | "source": [] 38 | } 39 | ], 40 | "metadata": { 41 | "kernelspec": { 42 | "display_name": "Python 2", 43 | "language": "python", 44 | "name": "python2" 45 | }, 46 | "language_info": { 47 | "codemirror_mode": { 48 | "name": "ipython", 49 | "version": 2 50 | }, 51 | "file_extension": ".py", 52 | "mimetype": "text/x-python", 53 | "name": "python", 54 | "nbconvert_exporter": "python", 55 | "pygments_lexer": "ipython2", 56 | "version": "2.7.10" 57 | } 58 | }, 59 | "nbformat": 4, 60 | "nbformat_minor": 0 61 | } 62 | -------------------------------------------------------------------------------- /docs/what_is_jupyter.rst: -------------------------------------------------------------------------------- 1 | .. _what_is_jupyther: 2 | 3 | What is the Jupyter Notebook? 4 | ============================= 5 | 6 | In this page briefly introduce the main components of the *Jupyter Notebook* 7 | environment. For a more complete overview see :ref:`references`. 8 | 9 | .. contents:: 10 | 11 | .. _notebook_document: 12 | 13 | Notebook document 14 | ----------------- 15 | 16 | Notebook documents (or "notebooks", all lower case) are documents 17 | produced by the :ref:`notebook_app`, which contain both computer code (e.g. python) 18 | and rich text elements (paragraph, equations, figures, links, etc...). 19 | Notebook documents are both human-readable documents containing the analysis 20 | description and the results (figures, tables, etc..) as well as executable documents 21 | which can be run to perform data analysis. 22 | 23 | **References**: Notebook documents `in the project homepage `__ and `in the official docs `__. 24 | 25 | .. _notebook_app: 26 | 27 | Jupyter Notebook App 28 | -------------------- 29 | 30 | The *Jupyter Notebook App* is a server-client application that allows 31 | editing and running :ref:`notebook documents ` 32 | via a web browser. 33 | The *Jupyter Notebook App* can be executed on a local desktop 34 | requiring no internet access (as described in this document) 35 | or can be installed on a remote server and accessed through the internet. 36 | 37 | In addition to displaying/editing/running notebook documents, 38 | the *Jupyter Notebook App* has a "Dashboard" (:ref:`dashboard`), 39 | a "control panel" showing local files and allowing to 40 | open notebook documents or shutting down their :ref:`kernels `. 41 | 42 | **References**: Jupyter Notebook App 43 | `in the project homepage `__ and 44 | `in the official docs `__. 45 | 46 | 47 | .. _kernel: 48 | 49 | kernel 50 | ------ 51 | 52 | A notebook *kernel* is a "computational engine" 53 | that executes the code contained in a :ref:`notebook_document`. 54 | The *ipython kernel*, referenced in this guide, executes python code. 55 | Kernels for many other languages exist 56 | (`official kernels `__). 57 | 58 | When you open a :ref:`notebook_document`, the associated *kernel* is automatically launched. 59 | When the notebook is *executed* (either cell-by-cell or with menu *Cell -> Run All*), 60 | the *kernel* performs the computation and produces the results. 61 | Depending on the type of computations, the *kernel* may consume significant 62 | CPU and RAM. Note that the RAM is not released until the *kernel* is shut-down. 63 | 64 | See also :ref:`kernel_shutdown`. 65 | 66 | **References**: from the official docs 67 | `Opening Notebooks `__ and 68 | `Decoupled two-process model `__. 69 | 70 | .. _dashboard: 71 | 72 | Notebook Dashboard 73 | ------------------ 74 | 75 | The *Notebook Dashboard* is the component which 76 | is shown first when you launch :ref:`notebook_app`. 77 | The *Notebook Dashboard* is mainly used to open :ref:`notebook documents `, 78 | and to manage the running :ref:`kernels ` (visualize and shutdown). 79 | 80 | The *Notebook Dashboard* has other features similar to a file manager, namely 81 | navigating folders and renaming/deleting files. 82 | 83 | **References**: from the official docs 84 | `Opening Notebooks `__. 85 | 86 | .. _references: 87 | 88 | References 89 | ---------- 90 | 91 | Official Jupyter Project Pages: 92 | 93 | - `Project Jupyter Homepage `__ 94 | - `Old IPython Notebook Homepage `__ 95 | 96 | Official Documentation: 97 | 98 | - `Jupyter Notebook Documentation `__ 99 | - `Jupyter Project Documentation `__ 100 | 101 | See also: 102 | 103 | - `What is the IPython Notebook? `__ 104 | 105 | - `Notebook Basics `__, an example notebook 106 | 107 | - `Introducing IPython Notebook `__ 108 | 109 | - `Jupyter Notebook: The Definitive Guide `__, an introductory tutorial to Jupyter 110 | 111 | 112 | .... 113 | 114 | The *Next* button will bring you to the next section (*Installation*). 115 | -------------------------------------------------------------------------------- /docs/execute.rst: -------------------------------------------------------------------------------- 1 | Running the Jupyter Notebook 2 | ============================= 3 | 4 | .. _launching_notebook: 5 | 6 | Launching *Jupyter Notebook App* 7 | -------------------------------- 8 | 9 | The :ref:`notebook_app` can be launched by clicking on the *Jupyter Notebook* 10 | icon installed by Anaconda in the start menu (Windows) or by typing in 11 | a terminal (*cmd* on Windows):: 12 | 13 | jupyter notebook 14 | 15 | This will launch a new browser window (or a new tab) showing the 16 | :ref:`dashboard`, a sort of control panel that allows (among other things) 17 | to select which notebook to open. 18 | 19 | When started, the :ref:`notebook_app` can access only files within its start-up folder 20 | (including any sub-folder). No configuration is necessary if you place your notebooks 21 | in your home folder or subfolders. 22 | Otherwise, you need to choose a :ref:`notebook_app` start-up folder which will contain 23 | all the notebooks. 24 | 25 | See below for platform-specific instructions on how to start 26 | :ref:`notebook_app` in a specific folder. 27 | 28 | Change Jupyter Notebook startup folder (Windows) 29 | '''''''''''''''''''''''''''''''''''''''''''''''' 30 | 31 | - Copy the *Jupyter Notebook* launcher from the menu to the desktop. 32 | 33 | - Right click on the new launcher and change the `Target field`, change *%USERPROFILE%* to 34 | the full path of the folder which will contain all the notebooks. 35 | 36 | - Double-click on the *Jupyter Notebook* desktop launcher (icon shows [IPy]) to start the 37 | :ref:`notebook_app`. The notebook interface will appear in a new browser window or tab. 38 | A secondary terminal window (used only for error logging and 39 | for shut down) will be also opened. 40 | 41 | .. |localhost| raw:: html 42 | 43 | http://localhost:8888/ 44 | 45 | 46 | Change Jupyter Notebook startup folder (Mac OS) 47 | '''''''''''''''''''''''''''''''''''''''''''''''' 48 | 49 | To launch :ref:`notebook_app`: 50 | 51 | - Click on spotlight, type ``terminal`` to open a terminal window. 52 | 53 | - Enter the startup folder by typing ``cd /some_folder_name``. 54 | 55 | - Type ``jupyter notebook`` to launch the :ref:`notebook_app` 56 | The notebook interface will appear in a new browser window or tab. 57 | 58 | 59 | Shut down the *Jupyter Notebook App* 60 | ------------------------------------ 61 | 62 | Closing the browser (or the tab) **will not close** the 63 | :ref:`notebook_app`. To completely shut it down you need to 64 | **close the associated terminal**. 65 | 66 | In more detail, 67 | the :ref:`notebook_app` is a server that appears in your browser 68 | at a default address (*http://localhost:8888*). 69 | Closing the browser will not shut down the server. 70 | You can reopen the previous address 71 | and the :ref:`notebook_app` will be redisplayed. 72 | 73 | You can run many copies of the :ref:`notebook_app` and they will show 74 | up at a similar address (only the number after ":", which is the port, 75 | will increment for each new copy). 76 | Since with a single :ref:`notebook_app` you can already open many notebooks, 77 | we do not recommend running multiple copies of :ref:`notebook_app`. 78 | 79 | 80 | .. _kernel_shutdown: 81 | 82 | Close a notebook: *kernel* shut down 83 | ------------------------------------ 84 | 85 | When a notebook is opened, its "computational engine" (called the :ref:`kernel`) 86 | is automatically started. 87 | Closing the notebook browser tab, will not shut down the :ref:`kernel`, 88 | instead the kernel will keep running until is explicitly shut down. 89 | 90 | To shut down a kernel, go to the associated notebook 91 | and click on menu *File* -> *Close and Halt*. Alternatively, the :ref:`dashboard` 92 | has a tab named *Running* that shows all the running notebooks (i.e. kernels) 93 | and allows shutting them down (by clicking on a *Shutdown* button). 94 | 95 | Executing a notebook 96 | -------------------- 97 | 98 | Download the notebook you want to execute and put it in your 99 | notebook folder (or a sub-folder of it). 100 | 101 | Then follow these steps: 102 | 103 | - Launch the :ref:`notebook_app` (see :ref:`previous section `). 104 | 105 | - In the :ref:`dashboard` navigate to find the notebook: 106 | clicking on its name will open it in a new browser tab. 107 | 108 | - Click on the menu *Help -> User Interface Tour* for an overview 109 | of the :ref:`notebook_app` user interface. 110 | 111 | - You can run the notebook document step-by-step (one cell a time) by pressing 112 | *shift + enter*. 113 | 114 | - You can run the whole notebook in a single step by clicking on the menu 115 | *Cell -> Run All*. 116 | 117 | - To restart the :ref:`kernel` (i.e. the computational engine), click on the menu 118 | *Kernel -> Restart*. This can be useful to start over a computation from 119 | scratch (e.g. variables are deleted, open files are closed, etc...). 120 | 121 | More information on editing a notebook: 122 | 123 | - `Notebook Basics `_ 124 | (or `alternate link `_) 125 | 126 | .. note:: 127 | 128 | **Save notebooks**: modifications to the notebooks are automatically saved every 129 | few minutes. To avoid modifying the original notebook, make a 130 | copy of the notebook document (menu *File -> Make a copy ...*) and 131 | save the modifications on the copy. 132 | 133 | 134 | .. warning:: 135 | 136 | Pay attention to not open the **same** notebook document 137 | on **many tabs**: edits on different tabs can overwrite each other! 138 | To be safe, make sure you open each notebook document in only one tab. 139 | If you accidentally open a notebook twice in two different tabs, just 140 | close one of the tabs. 141 | 142 | More info on the :ref:`notebook_app` environment see :ref:`references`. 143 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = sphinx-build 7 | PAPER = 8 | BUILDDIR = _build 9 | 10 | # User-friendly check for sphinx-build 11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) 12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) 13 | endif 14 | 15 | # Internal variables. 16 | PAPEROPT_a4 = -D latex_paper_size=a4 17 | PAPEROPT_letter = -D latex_paper_size=letter 18 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 19 | # the i18n builder cannot share the environment and doctrees with the others 20 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 21 | 22 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 23 | 24 | help: 25 | @echo "Please use \`make ' where is one of" 26 | @echo " html to make standalone HTML files" 27 | @echo " dirhtml to make HTML files named index.html in directories" 28 | @echo " singlehtml to make a single large HTML file" 29 | @echo " pickle to make pickle files" 30 | @echo " json to make JSON files" 31 | @echo " htmlhelp to make HTML files and a HTML help project" 32 | @echo " qthelp to make HTML files and a qthelp project" 33 | @echo " devhelp to make HTML files and a Devhelp project" 34 | @echo " epub to make an epub" 35 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 36 | @echo " latexpdf to make LaTeX files and run them through pdflatex" 37 | @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" 38 | @echo " text to make text files" 39 | @echo " man to make manual pages" 40 | @echo " texinfo to make Texinfo files" 41 | @echo " info to make Texinfo files and run them through makeinfo" 42 | @echo " gettext to make PO message catalogs" 43 | @echo " changes to make an overview of all changed/added/deprecated items" 44 | @echo " xml to make Docutils-native XML files" 45 | @echo " pseudoxml to make pseudoxml-XML files for display purposes" 46 | @echo " linkcheck to check all external links for integrity" 47 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" 48 | 49 | clean: 50 | rm -rf $(BUILDDIR)/* 51 | 52 | html: 53 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 54 | @echo 55 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 56 | 57 | dirhtml: 58 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 59 | @echo 60 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 61 | 62 | singlehtml: 63 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 64 | @echo 65 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 66 | 67 | pickle: 68 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 69 | @echo 70 | @echo "Build finished; now you can process the pickle files." 71 | 72 | json: 73 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 74 | @echo 75 | @echo "Build finished; now you can process the JSON files." 76 | 77 | htmlhelp: 78 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 79 | @echo 80 | @echo "Build finished; now you can run HTML Help Workshop with the" \ 81 | ".hhp project file in $(BUILDDIR)/htmlhelp." 82 | 83 | qthelp: 84 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 85 | @echo 86 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 87 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 88 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JupyterIPythonNotebookQuickStartGuide.qhcp" 89 | @echo "To view the help file:" 90 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JupyterIPythonNotebookQuickStartGuide.qhc" 91 | 92 | devhelp: 93 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 94 | @echo 95 | @echo "Build finished." 96 | @echo "To view the help file:" 97 | @echo "# mkdir -p $$HOME/.local/share/devhelp/JupyterIPythonNotebookQuickStartGuide" 98 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JupyterIPythonNotebookQuickStartGuide" 99 | @echo "# devhelp" 100 | 101 | epub: 102 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 103 | @echo 104 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 105 | 106 | latex: 107 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 108 | @echo 109 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 110 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ 111 | "(use \`make latexpdf' here to do that automatically)." 112 | 113 | latexpdf: 114 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 115 | @echo "Running LaTeX files through pdflatex..." 116 | $(MAKE) -C $(BUILDDIR)/latex all-pdf 117 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 118 | 119 | latexpdfja: 120 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 121 | @echo "Running LaTeX files through platex and dvipdfmx..." 122 | $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 123 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 124 | 125 | text: 126 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 127 | @echo 128 | @echo "Build finished. The text files are in $(BUILDDIR)/text." 129 | 130 | man: 131 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 132 | @echo 133 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 134 | 135 | texinfo: 136 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 137 | @echo 138 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 139 | @echo "Run \`make' in that directory to run these through makeinfo" \ 140 | "(use \`make info' here to do that automatically)." 141 | 142 | info: 143 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 144 | @echo "Running Texinfo files through makeinfo..." 145 | make -C $(BUILDDIR)/texinfo info 146 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 147 | 148 | gettext: 149 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 150 | @echo 151 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 152 | 153 | changes: 154 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 155 | @echo 156 | @echo "The overview file is in $(BUILDDIR)/changes." 157 | 158 | linkcheck: 159 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 160 | @echo 161 | @echo "Link check complete; look for any errors in the above output " \ 162 | "or in $(BUILDDIR)/linkcheck/output.txt." 163 | 164 | doctest: 165 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 166 | @echo "Testing of doctests in the sources finished, look at the " \ 167 | "results in $(BUILDDIR)/doctest/output.txt." 168 | 169 | xml: 170 | $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 171 | @echo 172 | @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 173 | 174 | pseudoxml: 175 | $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 176 | @echo 177 | @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 178 | -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | REM Command file for Sphinx documentation 4 | 5 | if "%SPHINXBUILD%" == "" ( 6 | set SPHINXBUILD=sphinx-build 7 | ) 8 | set BUILDDIR=_build 9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . 10 | set I18NSPHINXOPTS=%SPHINXOPTS% . 11 | if NOT "%PAPER%" == "" ( 12 | set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% 13 | set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% 14 | ) 15 | 16 | if "%1" == "" goto help 17 | 18 | if "%1" == "help" ( 19 | :help 20 | echo.Please use `make ^` where ^ is one of 21 | echo. html to make standalone HTML files 22 | echo. dirhtml to make HTML files named index.html in directories 23 | echo. singlehtml to make a single large HTML file 24 | echo. pickle to make pickle files 25 | echo. json to make JSON files 26 | echo. htmlhelp to make HTML files and a HTML help project 27 | echo. qthelp to make HTML files and a qthelp project 28 | echo. devhelp to make HTML files and a Devhelp project 29 | echo. epub to make an epub 30 | echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter 31 | echo. text to make text files 32 | echo. man to make manual pages 33 | echo. texinfo to make Texinfo files 34 | echo. gettext to make PO message catalogs 35 | echo. changes to make an overview over all changed/added/deprecated items 36 | echo. xml to make Docutils-native XML files 37 | echo. pseudoxml to make pseudoxml-XML files for display purposes 38 | echo. linkcheck to check all external links for integrity 39 | echo. doctest to run all doctests embedded in the documentation if enabled 40 | goto end 41 | ) 42 | 43 | if "%1" == "clean" ( 44 | for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i 45 | del /q /s %BUILDDIR%\* 46 | goto end 47 | ) 48 | 49 | 50 | %SPHINXBUILD% 2> nul 51 | if errorlevel 9009 ( 52 | echo. 53 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 54 | echo.installed, then set the SPHINXBUILD environment variable to point 55 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 56 | echo.may add the Sphinx directory to PATH. 57 | echo. 58 | echo.If you don't have Sphinx installed, grab it from 59 | echo.http://sphinx-doc.org/ 60 | exit /b 1 61 | ) 62 | 63 | if "%1" == "html" ( 64 | %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html 65 | if errorlevel 1 exit /b 1 66 | echo. 67 | echo.Build finished. The HTML pages are in %BUILDDIR%/html. 68 | goto end 69 | ) 70 | 71 | if "%1" == "dirhtml" ( 72 | %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml 73 | if errorlevel 1 exit /b 1 74 | echo. 75 | echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. 76 | goto end 77 | ) 78 | 79 | if "%1" == "singlehtml" ( 80 | %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml 81 | if errorlevel 1 exit /b 1 82 | echo. 83 | echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. 84 | goto end 85 | ) 86 | 87 | if "%1" == "pickle" ( 88 | %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle 89 | if errorlevel 1 exit /b 1 90 | echo. 91 | echo.Build finished; now you can process the pickle files. 92 | goto end 93 | ) 94 | 95 | if "%1" == "json" ( 96 | %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json 97 | if errorlevel 1 exit /b 1 98 | echo. 99 | echo.Build finished; now you can process the JSON files. 100 | goto end 101 | ) 102 | 103 | if "%1" == "htmlhelp" ( 104 | %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp 105 | if errorlevel 1 exit /b 1 106 | echo. 107 | echo.Build finished; now you can run HTML Help Workshop with the ^ 108 | .hhp project file in %BUILDDIR%/htmlhelp. 109 | goto end 110 | ) 111 | 112 | if "%1" == "qthelp" ( 113 | %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp 114 | if errorlevel 1 exit /b 1 115 | echo. 116 | echo.Build finished; now you can run "qcollectiongenerator" with the ^ 117 | .qhcp project file in %BUILDDIR%/qthelp, like this: 118 | echo.^> qcollectiongenerator %BUILDDIR%\qthelp\JupyterIPythonNotebookQuickStartGuide.qhcp 119 | echo.To view the help file: 120 | echo.^> assistant -collectionFile %BUILDDIR%\qthelp\JupyterIPythonNotebookQuickStartGuide.ghc 121 | goto end 122 | ) 123 | 124 | if "%1" == "devhelp" ( 125 | %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp 126 | if errorlevel 1 exit /b 1 127 | echo. 128 | echo.Build finished. 129 | goto end 130 | ) 131 | 132 | if "%1" == "epub" ( 133 | %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub 134 | if errorlevel 1 exit /b 1 135 | echo. 136 | echo.Build finished. The epub file is in %BUILDDIR%/epub. 137 | goto end 138 | ) 139 | 140 | if "%1" == "latex" ( 141 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 142 | if errorlevel 1 exit /b 1 143 | echo. 144 | echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. 145 | goto end 146 | ) 147 | 148 | if "%1" == "latexpdf" ( 149 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 150 | cd %BUILDDIR%/latex 151 | make all-pdf 152 | cd %BUILDDIR%/.. 153 | echo. 154 | echo.Build finished; the PDF files are in %BUILDDIR%/latex. 155 | goto end 156 | ) 157 | 158 | if "%1" == "latexpdfja" ( 159 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 160 | cd %BUILDDIR%/latex 161 | make all-pdf-ja 162 | cd %BUILDDIR%/.. 163 | echo. 164 | echo.Build finished; the PDF files are in %BUILDDIR%/latex. 165 | goto end 166 | ) 167 | 168 | if "%1" == "text" ( 169 | %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text 170 | if errorlevel 1 exit /b 1 171 | echo. 172 | echo.Build finished. The text files are in %BUILDDIR%/text. 173 | goto end 174 | ) 175 | 176 | if "%1" == "man" ( 177 | %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man 178 | if errorlevel 1 exit /b 1 179 | echo. 180 | echo.Build finished. The manual pages are in %BUILDDIR%/man. 181 | goto end 182 | ) 183 | 184 | if "%1" == "texinfo" ( 185 | %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo 186 | if errorlevel 1 exit /b 1 187 | echo. 188 | echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. 189 | goto end 190 | ) 191 | 192 | if "%1" == "gettext" ( 193 | %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale 194 | if errorlevel 1 exit /b 1 195 | echo. 196 | echo.Build finished. The message catalogs are in %BUILDDIR%/locale. 197 | goto end 198 | ) 199 | 200 | if "%1" == "changes" ( 201 | %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes 202 | if errorlevel 1 exit /b 1 203 | echo. 204 | echo.The overview file is in %BUILDDIR%/changes. 205 | goto end 206 | ) 207 | 208 | if "%1" == "linkcheck" ( 209 | %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck 210 | if errorlevel 1 exit /b 1 211 | echo. 212 | echo.Link check complete; look for any errors in the above output ^ 213 | or in %BUILDDIR%/linkcheck/output.txt. 214 | goto end 215 | ) 216 | 217 | if "%1" == "doctest" ( 218 | %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest 219 | if errorlevel 1 exit /b 1 220 | echo. 221 | echo.Testing of doctests in the sources finished, look at the ^ 222 | results in %BUILDDIR%/doctest/output.txt. 223 | goto end 224 | ) 225 | 226 | if "%1" == "xml" ( 227 | %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml 228 | if errorlevel 1 exit /b 1 229 | echo. 230 | echo.Build finished. The XML files are in %BUILDDIR%/xml. 231 | goto end 232 | ) 233 | 234 | if "%1" == "pseudoxml" ( 235 | %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml 236 | if errorlevel 1 exit /b 1 237 | echo. 238 | echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. 239 | goto end 240 | ) 241 | 242 | :end 243 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Jupyter/IPython Notebook Quick Start Guide documentation build configuration file, created by 4 | # sphinx-quickstart on Sat Jun 13 10:59:36 2015. 5 | # 6 | # This file is execfile()d with the current directory set to its 7 | # containing dir. 8 | # 9 | # Note that not all possible configuration values are present in this 10 | # autogenerated file. 11 | # 12 | # All configuration values have a default; values that are commented out 13 | # serve to show the default. 14 | 15 | import sys 16 | import os 17 | 18 | on_rtd = os.environ.get('READTHEDOCS', None) == 'True' 19 | 20 | # If extensions (or modules to document with autodoc) are in another directory, 21 | # add these directories to sys.path here. If the directory is relative to the 22 | # documentation root, use os.path.abspath to make it absolute, like shown here. 23 | #sys.path.insert(0, os.path.abspath('.')) 24 | 25 | # -- General configuration ------------------------------------------------ 26 | 27 | # If your documentation needs a minimal Sphinx version, state it here. 28 | #needs_sphinx = '1.0' 29 | 30 | # Add any Sphinx extension module names here, as strings. They can be 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 32 | # ones. 33 | extensions = [] 34 | 35 | # Add any paths that contain templates here, relative to this directory. 36 | templates_path = ['_templates'] 37 | 38 | # The suffix of source filenames. 39 | source_suffix = '.rst' 40 | 41 | # The encoding of source files. 42 | #source_encoding = 'utf-8-sig' 43 | 44 | # The master toctree document. 45 | master_doc = 'index' 46 | 47 | # General information about the project. 48 | project = u'Jupyter/IPython Notebook Quick Start Guide' 49 | copyright = u'2015, Antonino Ingargiola and contributors' 50 | 51 | # The version info for the project you're documenting, acts as replacement for 52 | # |version| and |release|, also used in various other places throughout the 53 | # built documents. 54 | # 55 | # The short X.Y version. 56 | version = '0.1' 57 | # The full version, including alpha/beta/rc tags. 58 | release = '0.1' 59 | 60 | # The language for content autogenerated by Sphinx. Refer to documentation 61 | # for a list of supported languages. 62 | #language = None 63 | 64 | # There are two options for replacing |today|: either, you set today to some 65 | # non-false value, then it is used: 66 | #today = '' 67 | # Else, today_fmt is used as the format for a strftime call. 68 | #today_fmt = '%B %d, %Y' 69 | 70 | # List of patterns, relative to source directory, that match files and 71 | # directories to ignore when looking for source files. 72 | exclude_patterns = ['_build'] 73 | 74 | # The reST default role (used for this markup: `text`) to use for all 75 | # documents. 76 | #default_role = None 77 | 78 | # If true, '()' will be appended to :func: etc. cross-reference text. 79 | #add_function_parentheses = True 80 | 81 | # If true, the current module name will be prepended to all description 82 | # unit titles (such as .. function::). 83 | #add_module_names = True 84 | 85 | # If true, sectionauthor and moduleauthor directives will be shown in the 86 | # output. They are ignored by default. 87 | #show_authors = False 88 | 89 | # The name of the Pygments (syntax highlighting) style to use. 90 | pygments_style = 'sphinx' 91 | 92 | # A list of ignored prefixes for module index sorting. 93 | #modindex_common_prefix = [] 94 | 95 | # If true, keep warnings as "system message" paragraphs in the built documents. 96 | #keep_warnings = False 97 | 98 | 99 | # -- Options for HTML output ---------------------------------------------- 100 | 101 | # The theme to use for HTML and HTML Help pages. See the documentation for 102 | # a list of builtin themes. 103 | #html_theme = 'default' 104 | if not on_rtd: 105 | import sphinx_rtd_theme 106 | html_theme = 'sphinx_rtd_theme' 107 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] 108 | 109 | # Theme options are theme-specific and customize the look and feel of a theme 110 | # further. For a list of options available for each theme, see the 111 | # documentation. 112 | #html_theme_options = {} 113 | 114 | # Add any paths that contain custom themes here, relative to this directory. 115 | #html_theme_path = [] 116 | 117 | # The name for this set of Sphinx documents. If None, it defaults to 118 | # " v documentation". 119 | #html_title = None 120 | 121 | # A shorter title for the navigation bar. Default is the same as html_title. 122 | #html_short_title = None 123 | 124 | # The name of an image file (relative to this directory) to place at the top 125 | # of the sidebar. 126 | #html_logo = None 127 | 128 | # The name of an image file (within the static path) to use as favicon of the 129 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 130 | # pixels large. 131 | #html_favicon = None 132 | 133 | # Add any paths that contain custom static files (such as style sheets) here, 134 | # relative to this directory. They are copied after the builtin static files, 135 | # so a file named "default.css" will overwrite the builtin "default.css". 136 | html_static_path = ['_static'] 137 | 138 | # Add any extra paths that contain custom files (such as robots.txt or 139 | # .htaccess) here, relative to this directory. These files are copied 140 | # directly to the root of the documentation. 141 | #html_extra_path = [] 142 | 143 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 144 | # using the given strftime format. 145 | #html_last_updated_fmt = '%b %d, %Y' 146 | 147 | # If true, SmartyPants will be used to convert quotes and dashes to 148 | # typographically correct entities. 149 | #html_use_smartypants = True 150 | 151 | # Custom sidebar templates, maps document names to template names. 152 | #html_sidebars = {} 153 | 154 | # Additional templates that should be rendered to pages, maps page names to 155 | # template names. 156 | #html_additional_pages = {} 157 | 158 | # If false, no module index is generated. 159 | #html_domain_indices = True 160 | 161 | # If false, no index is generated. 162 | #html_use_index = True 163 | 164 | # If true, the index is split into individual pages for each letter. 165 | #html_split_index = False 166 | 167 | # If true, links to the reST sources are added to the pages. 168 | #html_show_sourcelink = True 169 | 170 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 171 | #html_show_sphinx = True 172 | 173 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 174 | #html_show_copyright = True 175 | 176 | # If true, an OpenSearch description file will be output, and all pages will 177 | # contain a tag referring to it. The value of this option must be the 178 | # base URL from which the finished HTML is served. 179 | #html_use_opensearch = '' 180 | 181 | # This is the file name suffix for HTML files (e.g. ".xhtml"). 182 | #html_file_suffix = None 183 | 184 | # Output file base name for HTML help builder. 185 | htmlhelp_basename = 'JupyterIPythonNotebookQuickStartGuidedoc' 186 | 187 | 188 | # -- Options for LaTeX output --------------------------------------------- 189 | 190 | latex_elements = { 191 | # The paper size ('letterpaper' or 'a4paper'). 192 | #'papersize': 'letterpaper', 193 | 194 | # The font size ('10pt', '11pt' or '12pt'). 195 | #'pointsize': '10pt', 196 | 197 | # Additional stuff for the LaTeX preamble. 198 | #'preamble': '', 199 | } 200 | 201 | # Grouping the document tree into LaTeX files. List of tuples 202 | # (source start file, target name, title, 203 | # author, documentclass [howto, manual, or own class]). 204 | latex_documents = [ 205 | ('index', 206 | 'JupyterIPythonNotebookQuickStartGuide.tex', 207 | u'Jupyter/IPython Notebook Quick Start Guide Documentation', 208 | u'Antonino Ingargiola and other contributors', 209 | 'manual'), 210 | ] 211 | 212 | # The name of an image file (relative to this directory) to place at the top of 213 | # the title page. 214 | #latex_logo = None 215 | 216 | # For "manual" documents, if this is true, then toplevel headings are parts, 217 | # not chapters. 218 | #latex_use_parts = False 219 | 220 | # If true, show page references after internal links. 221 | #latex_show_pagerefs = False 222 | 223 | # If true, show URL addresses after external links. 224 | #latex_show_urls = False 225 | 226 | # Documents to append as an appendix to all manuals. 227 | #latex_appendices = [] 228 | 229 | # If false, no module index is generated. 230 | #latex_domain_indices = True 231 | 232 | 233 | # -- Options for manual page output --------------------------------------- 234 | 235 | # One entry per manual page. List of tuples 236 | # (source start file, name, description, authors, manual section). 237 | man_pages = [ 238 | ('index', 'jupyteripythonnotebookquickstartguide', u'Jupyter/IPython Notebook Quick Start Guide Documentation', 239 | [u'Antonino Ingargiola and other contributors'], 1) 240 | ] 241 | 242 | # If true, show URL addresses after external links. 243 | #man_show_urls = False 244 | 245 | 246 | # -- Options for Texinfo output ------------------------------------------- 247 | 248 | # Grouping the document tree into Texinfo files. List of tuples 249 | # (source start file, target name, title, author, 250 | # dir menu entry, description, category) 251 | texinfo_documents = [ 252 | ('index', 'JupyterIPythonNotebookQuickStartGuide', u'Jupyter/IPython Notebook Quick Start Guide Documentation', 253 | u'Antonino Ingargiola', 'JupyterIPythonNotebookQuickStartGuide', 'One line description of project.', 254 | 'Miscellaneous'), 255 | ] 256 | 257 | # Documents to append as an appendix to all manuals. 258 | #texinfo_appendices = [] 259 | 260 | # If false, no module index is generated. 261 | #texinfo_domain_indices = True 262 | 263 | # How to display URL addresses: 'footnote', 'no', or 'inline'. 264 | #texinfo_show_urls = 'footnote' 265 | 266 | # If true, do not generate a @detailmenu in the "Top" node's menu. 267 | #texinfo_no_detailmenu = False 268 | 269 | 270 | # -- Options for Epub output ---------------------------------------------- 271 | 272 | # Bibliographic Dublin Core info. 273 | epub_title = u'Jupyter/IPython Notebook Quick Start Guide' 274 | epub_author = u'Antonino Ingargiola' 275 | epub_publisher = u'Antonino Ingargiola' 276 | epub_copyright = u'2015, Antonino Ingargiola' 277 | 278 | # The basename for the epub file. It defaults to the project name. 279 | #epub_basename = u'Jupyter/IPython Notebook Quick Start Guide' 280 | 281 | # The HTML theme for the epub output. Since the default themes are not optimized 282 | # for small screen space, using the same theme for HTML and epub output is 283 | # usually not wise. This defaults to 'epub', a theme designed to save visual 284 | # space. 285 | #epub_theme = 'epub' 286 | 287 | # The language of the text. It defaults to the language option 288 | # or en if the language is not set. 289 | #epub_language = '' 290 | 291 | # The scheme of the identifier. Typical schemes are ISBN or URL. 292 | #epub_scheme = '' 293 | 294 | # The unique identifier of the text. This can be a ISBN number 295 | # or the project homepage. 296 | #epub_identifier = '' 297 | 298 | # A unique identification for the text. 299 | #epub_uid = '' 300 | 301 | # A tuple containing the cover image and cover page html template filenames. 302 | #epub_cover = () 303 | 304 | # A sequence of (type, uri, title) tuples for the guide element of content.opf. 305 | #epub_guide = () 306 | 307 | # HTML files that should be inserted before the pages created by sphinx. 308 | # The format is a list of tuples containing the path and title. 309 | #epub_pre_files = [] 310 | 311 | # HTML files shat should be inserted after the pages created by sphinx. 312 | # The format is a list of tuples containing the path and title. 313 | #epub_post_files = [] 314 | 315 | # A list of files that should not be packed into the epub file. 316 | epub_exclude_files = ['search.html'] 317 | 318 | # The depth of the table of contents in toc.ncx. 319 | #epub_tocdepth = 3 320 | 321 | # Allow duplicate toc entries. 322 | #epub_tocdup = True 323 | 324 | # Choose between 'default' and 'includehidden'. 325 | #epub_tocscope = 'default' 326 | 327 | # Fix unsupported image types using the PIL. 328 | #epub_fix_images = False 329 | 330 | # Scale large images. 331 | #epub_max_image_width = 0 332 | 333 | # How to display URL addresses: 'footnote', 'no', or 'inline'. 334 | #epub_show_urls = 'inline' 335 | 336 | # If false, no index is generated. 337 | #epub_use_index = True 338 | --------------------------------------------------------------------------------