diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000..a752654ba6 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,192 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(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/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JupyterNotebook.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JupyterNotebook.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/JupyterNotebook" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JupyterNotebook" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000000..741c9f6eb2 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,263 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source +set I18NSPHINXOPTS=%SPHINXOPTS% source +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + echo. coverage to run coverage check of the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 2> nul +if errorlevel 9009 goto sphinx_python +goto sphinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +:sphinx_ok + + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\JupyterNotebook.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\JupyterNotebook.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "coverage" ( + %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage + if errorlevel 1 exit /b 1 + echo. + echo.Testing of coverage in the sources finished, look at the ^ +results in %BUILDDIR%/coverage/python.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000000..8662935d6d --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,293 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Jupyter Notebook documentation build configuration file, created by +# sphinx-quickstart on Mon Apr 13 09:51:11 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Jupyter Notebook' +copyright = '2015, https://er' +author = 'https://er' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '4.0.0.dev' +# The full version, including alpha/beta/rc tags. +release = '4.0.0.dev' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'JupyterNotebookdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'JupyterNotebook.tex', 'Jupyter Notebook Documentation', + 'https://er', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'jupyternotebook', 'Jupyter Notebook Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'JupyterNotebook', 'Jupyter Notebook Documentation', + author, 'JupyterNotebook', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +intersphinx_mapping = { + 'ipython': ('http://ipython.org/ipython-doc/dev/', None) +} diff --git a/docs/source/notebook/index.rst b/docs/source/index.rst similarity index 100% rename from docs/source/notebook/index.rst rename to docs/source/index.rst diff --git a/docs/source/notebook/ipython_security.asc b/docs/source/ipython_security.asc similarity index 100% rename from docs/source/notebook/ipython_security.asc rename to docs/source/ipython_security.asc diff --git a/docs/source/links.txt b/docs/source/links.txt new file mode 100644 index 0000000000..33d9479e19 --- /dev/null +++ b/docs/source/links.txt @@ -0,0 +1,38 @@ +.. This (-*- rst -*-) format file contains commonly used link targets + and name substitutions. It may be included in many files, + therefore it should only contain link targets and name + substitutions. Try grepping for "^\.\. _" to find plausible + candidates for this list. + + NOTE: this file must have an extension *opposite* to that of the main reST + files in the manuals, so that we can include it with ".. include::" + directives, but without triggering warnings from Sphinx for not being listed + in any toctree. Since IPython uses .txt for the main files, this one will + use .rst. + + NOTE: reST targets are + __not_case_sensitive__, so only one target definition is needed for + ipython, IPython, etc. + + NOTE: Some of these were taken from the nipy links compendium. + +.. Main IPython links + +.. _Basic Output: notebook_p2_ +.. _notebook_p2: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%202%20-%20Basic%20Output.ipynb + +.. _Running Code in the IPython Notebook: notebook_p1_ +.. _notebook_p1: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%25201%2520-%2520Running%2520Code.ipynb + +.. Other python projects +.. _matplotlib: http://matplotlib.org +.. _nbviewer: http://nbviewer.ipython.org + +.. Other tools and projects +.. _Markdown: http://daringfireball.net/projects/markdown/syntax + +.. _Rich Display System: notebook_p5_ +.. _notebook_p5: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%205%20-%20Rich%20Display%20System.ipynb + +.. _Plotting with Matplotlib: notebook_p3_ +.. _notebook_p3: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%203%20-%20Plotting%20with%20Matplotlib.ipynb diff --git a/docs/source/notebook/nbconvert.rst b/docs/source/nbconvert.rst similarity index 100% rename from docs/source/notebook/nbconvert.rst rename to docs/source/nbconvert.rst diff --git a/docs/source/notebook/nbformat.rst b/docs/source/nbformat.rst similarity index 100% rename from docs/source/notebook/nbformat.rst rename to docs/source/nbformat.rst diff --git a/docs/source/notebook/notebook.rst b/docs/source/notebook.rst similarity index 93% rename from docs/source/notebook/notebook.rst rename to docs/source/notebook.rst index 2e0893dc21..24060a1a99 100644 --- a/docs/source/notebook/notebook.rst +++ b/docs/source/notebook.rst @@ -59,15 +59,15 @@ record of a session, interleaving executable code with explanatory text, mathematics, and rich representations of resulting objects. These documents are internally JSON_ files and are saved with the ``.ipynb`` extension. Since JSON is a plain text format, they can be version-controlled and shared with -colleagues. - +colleagues. + .. _JSON: http://en.wikipedia.org/wiki/JSON Notebooks may be exported to a range of static formats, including HTML (for example, for blog posts), reStructuredText, LaTeX, PDF, and slide shows, via the new :ref:`nbconvert ` command. -Furthermore, any ``.ipynb`` notebook document available from a public +Furthermore, any ``.ipynb`` notebook document available from a public URL can be shared via the `IPython Notebook Viewer `_ (nbviewer_). This service loads the notebook document from the URL and renders it as a static web page. The results may thus be shared with a colleague, or as a @@ -80,8 +80,8 @@ nbviewer. .. seealso:: - :ref:`Details on the notebook JSON file format ` - + :ref:`Details on the notebook JSON file format ` + Starting the notebook server ---------------------------- @@ -116,10 +116,10 @@ from the notebook directory or to create a new notebook. .. note:: - You can start more than one notebook server at the same time, if you want - to work on notebooks in different directories. By default the first - notebook server starts on port 8888, and later notebook servers search for - ports near that one. You can also manually specify the port with the + You can start more than one notebook server at the same time, if you want + to work on notebooks in different directories. By default the first + notebook server starts on port 8888, and later notebook servers search for + ports near that one. You can also manually specify the port with the ``--port`` option. Creating a new notebook document @@ -142,7 +142,7 @@ with an active kernel have a ``Shutdown`` button next to them, whereas notebooks without an active kernel have a ``Delete`` button in its place. Other clients may connect to the same underlying IPython kernel. -The notebook server always prints to the terminal the full details of +The notebook server always prints to the terminal the full details of how to connect to each kernel, with messages such as the following:: [NotebookApp] Kernel started: 87f7d2c0-13e3-43df-8bb8-1bd37aaf3373 @@ -158,7 +158,7 @@ kernel from the command line, by passing a portion of the ID:: $ ipython qtconsole --existing 87f7d2c0 -Without an ID, ``--existing`` will connect to the most recently +Without an ID, ``--existing`` will connect to the most recently started kernel. This can also be done by running the ``%qtconsole`` :ref:`magic ` in the notebook. @@ -178,7 +178,7 @@ of the page, next to the ``IP[y]: Notebook`` logo. This name reflects the name of the ``.ipynb`` notebook document file. Clicking on the notebook name brings up a dialog which allows you to rename it. Thus, renaming a notebook from "Untitled0" to "My first notebook" in the browser, renames the -``Untitled0.ipynb`` file to ``My first notebook.ipynb``. +``Untitled0.ipynb`` file to ``My first notebook.ipynb``. **menu bar**: The menu bar presents different options that may be used to manipulate the way the notebook functions. @@ -200,7 +200,7 @@ the cell's type. There are four types of cells: **code cells**, **markdown cells**, **raw cells** and **heading cells**. Every cell starts off being a **code cell**, but its type can be changed by using a dropdown on the toolbar (which will be "Code", initially), or via :ref:`keyboard shortcuts -`. +`. For more information on the different things you can do in a notebook, see the `collection of examples @@ -214,11 +214,11 @@ cell is Python, but other languages, such as ``Julia`` and ``R``, can be handled using :ref:`cell magic commands `. When a code cell is executed, code that it contains is sent to the kernel -associated with the notebook. The results that are returned from this +associated with the notebook. The results that are returned from this computation are then displayed in the notebook as the cell's *output*. The output is not limited to text, with many other possible forms of output are -also possible, including ``matplotlib`` figures and HTML tables (as used, for -example, in the ``pandas`` data analysis package). This is known as IPython's +also possible, including ``matplotlib`` figures and HTML tables (as used, for +example, in the ``pandas`` data analysis package). This is known as IPython's *rich display* capability. .. seealso:: @@ -229,34 +229,34 @@ example, in the ``pandas`` data analysis package). This is known as IPython's Markdown cells ~~~~~~~~~~~~~~ -You can document the computational process in a literate way, alternating -descriptive text with code, using *rich text*. In IPython this is accomplished -by marking up text with the Markdown language. The corresponding cells are -called *Markdown cells*. The Markdown language provides a simple way to -perform this text markup, that is, to specify which parts of the text should -be emphasized (italics), bold, form lists, etc. +You can document the computational process in a literate way, alternating +descriptive text with code, using *rich text*. In IPython this is accomplished +by marking up text with the Markdown language. The corresponding cells are +called *Markdown cells*. The Markdown language provides a simple way to +perform this text markup, that is, to specify which parts of the text should +be emphasized (italics), bold, form lists, etc. -When a Markdown cell is executed, the Markdown code is converted into +When a Markdown cell is executed, the Markdown code is converted into the corresponding formatted rich text. Markdown allows arbitrary HTML code for formatting. -Within Markdown cells, you can also include *mathematics* in a straightforward -way, using standard LaTeX notation: ``$...$`` for inline mathematics and -``$$...$$`` for displayed mathematics. When the Markdown cell is executed, -the LaTeX portions are automatically rendered in the HTML output as equations -with high quality typography. This is made possible by MathJax_, which -supports a `large subset `_ of LaTeX functionality +Within Markdown cells, you can also include *mathematics* in a straightforward +way, using standard LaTeX notation: ``$...$`` for inline mathematics and +``$$...$$`` for displayed mathematics. When the Markdown cell is executed, +the LaTeX portions are automatically rendered in the HTML output as equations +with high quality typography. This is made possible by MathJax_, which +supports a `large subset `_ of LaTeX functionality .. _mathjax_tex: http://docs.mathjax.org/en/latest/tex.html -Standard mathematics environments defined by LaTeX and AMS-LaTeX (the -`amsmath` package) also work, such as +Standard mathematics environments defined by LaTeX and AMS-LaTeX (the +`amsmath` package) also work, such as ``\begin{equation}...\end{equation}``, and ``\begin{align}...\end{align}``. -New LaTeX macros may be defined using standard methods, -such as ``\newcommand``, by placing them anywhere *between math delimiters* in -a Markdown cell. These definitions are then available throughout the rest of -the IPython session. +New LaTeX macros may be defined using standard methods, +such as ``\newcommand``, by placing them anywhere *between math delimiters* in +a Markdown cell. These definitions are then available throughout the rest of +the IPython session. .. seealso:: @@ -275,10 +275,10 @@ nbconvert. Heading cells ~~~~~~~~~~~~~ -You can provide a conceptual structure for your computational document as a -whole using different levels of headings; there are 6 levels available, from -level 1 (top level) down to level 6 (paragraph). These can be used later for -constructing tables of contents, etc. As with Markdown cells, a heading +You can provide a conceptual structure for your computational document as a +whole using different levels of headings; there are 6 levels available, from +level 1 (top level) down to level 6 (paragraph). These can be used later for +constructing tables of contents, etc. As with Markdown cells, a heading cell is replaced by a rich text rendering of the heading when the cell is executed. @@ -286,29 +286,29 @@ executed. Basic workflow -------------- -The normal workflow in a notebook is, then, quite similar to a standard -IPython session, with the difference that you can edit cells in-place multiple -times until you obtain the desired results, rather than having to -rerun separate scripts with the ``%run`` magic command. +The normal workflow in a notebook is, then, quite similar to a standard +IPython session, with the difference that you can edit cells in-place multiple +times until you obtain the desired results, rather than having to +rerun separate scripts with the ``%run`` magic command. -Typically, you will work on a computational problem in pieces, organizing -related ideas into cells and moving forward once previous parts work -correctly. This is much more convenient for interactive exploration than -breaking up a computation into scripts that must be executed together, as was +Typically, you will work on a computational problem in pieces, organizing +related ideas into cells and moving forward once previous parts work +correctly. This is much more convenient for interactive exploration than +breaking up a computation into scripts that must be executed together, as was previously necessary, especially if parts of them take a long time to run. -At certain moments, it may be necessary to interrupt a calculation which is -taking too long to complete. This may be done with the `Kernel | Interrupt` +At certain moments, it may be necessary to interrupt a calculation which is +taking too long to complete. This may be done with the `Kernel | Interrupt` menu option, or the :kbd:`Ctrl-m i` keyboard shortcut. -Similarly, it may be necessary or desirable to restart the whole computational -process, with the `Kernel | Restart` menu option or :kbd:`Ctrl-m .` -shortcut. +Similarly, it may be necessary or desirable to restart the whole computational +process, with the `Kernel | Restart` menu option or :kbd:`Ctrl-m .` +shortcut. A notebook may be downloaded in either a ``.ipynb`` or ``.py`` file from the menu option `File | Download as`. Choosing the ``.py`` option downloads a Python ``.py`` script, in which all rich output has been removed and the -content of markdown cells have been inserted as comments. +content of markdown cells have been inserted as comments. .. seealso:: @@ -322,20 +322,20 @@ content of markdown cells have been inserted as comments. Keyboard shortcuts ~~~~~~~~~~~~~~~~~~ -All actions in the notebook can be performed with the mouse, but keyboard +All actions in the notebook can be performed with the mouse, but keyboard shortcuts are also available for the most common ones. The essential shortcuts to remember are the following: * :kbd:`Shift-Enter`: run cell - Execute the current cell, show output (if any), and jump to the next cell - below. If :kbd:`Shift-Enter` is invoked on the last cell, a new code - cell will also be created. Note that in the notebook, typing :kbd:`Enter` - on its own *never* forces execution, but rather just inserts a new line in - the current cell. :kbd:`Shift-Enter` is equivalent to clicking the + Execute the current cell, show output (if any), and jump to the next cell + below. If :kbd:`Shift-Enter` is invoked on the last cell, a new code + cell will also be created. Note that in the notebook, typing :kbd:`Enter` + on its own *never* forces execution, but rather just inserts a new line in + the current cell. :kbd:`Shift-Enter` is equivalent to clicking the ``Cell | Run`` menu item. * :kbd:`Ctrl-Enter`: run cell in-place - Execute the current cell as if it were in "terminal mode", where any + Execute the current cell as if it were in "terminal mode", where any output is shown, but the cursor *remains* in the current cell. The cell's entire contents are selected after execution, so you can just start typing and only the new input will be in the cell. This is convenient for doing @@ -344,11 +344,11 @@ to remember are the following: to be saved in the notebook. * :kbd:`Alt-Enter`: run cell, insert below - Executes the current cell, shows the output, and inserts a *new* - cell between the current cell and the cell below (if one exists). This + Executes the current cell, shows the output, and inserts a *new* + cell between the current cell and the cell below (if one exists). This is thus a shortcut for the sequence :kbd:`Shift-Enter`, :kbd:`Ctrl-m a`. (:kbd:`Ctrl-m a` adds a new cell above the current one.) - + * :kbd:`Esc` and :kbd:`Enter`: Command mode and edit mode In command mode, you can easily navigate around the notebook using keyboard shortcuts. In edit mode, you can edit text in cells. @@ -360,7 +360,7 @@ Plotting -------- One major feature of the notebook is the ability to display plots that are the output of running code cells. IPython is designed to work seamlessly with the -matplotlib_ plotting library to provide this functionality. +matplotlib_ plotting library to provide this functionality. To set this up, before any plotting is performed you must execute the ``%matplotlib`` :ref:`magic command `. This performs the @@ -368,9 +368,9 @@ necessary behind-the-scenes setup for IPython to work correctly hand in hand with ``matplotlib``; it does *not*, however, actually execute any Python ``import`` commands, that is, no names are added to the namespace. -If the ``%matplotlib`` magic is called without an argument, the -output of a plotting command is displayed using the default ``matplotlib`` -backend in a separate window. Alternatively, the backend can be explicitly +If the ``%matplotlib`` magic is called without an argument, the +output of a plotting command is displayed using the default ``matplotlib`` +backend in a separate window. Alternatively, the backend can be explicitly requested using, for example:: %matplotlib gtk @@ -383,7 +383,7 @@ backend. This is available only for the IPython Notebook and the With this backend, the output of plotting commands is displayed *inline* within the notebook, directly below the code cell that produced it. The -resulting plots will then also be stored in the notebook document. +resulting plots will then also be stored in the notebook document. .. seealso:: @@ -392,19 +392,19 @@ resulting plots will then also be stored in the notebook document. Configuring the IPython Notebook -------------------------------- -The notebook server can be run with a variety of command line arguments. +The notebook server can be run with a variety of command line arguments. To see a list of available options enter:: - $ ipython notebook --help + $ ipython notebook --help -Defaults for these options can also be set by creating a file named -``ipython_notebook_config.py`` in your IPython *profile folder*. The profile -folder is a subfolder of your IPython directory; to find out where it is +Defaults for these options can also be set by creating a file named +``ipython_notebook_config.py`` in your IPython *profile folder*. The profile +folder is a subfolder of your IPython directory; to find out where it is located, run:: $ ipython locate -To create a new set of default configuration files, with lots of information +To create a new set of default configuration files, with lots of information on available options, use:: $ ipython profile create @@ -412,7 +412,7 @@ on available options, use:: .. seealso:: :ref:`config_overview`, in particular :ref:`Profiles`. - + :ref:`notebook_server_security` :ref:`notebook_public_server` @@ -470,11 +470,11 @@ You can generate a new notebook signing key with:: Importing ``.py`` files ----------------------- -``.py`` files will be imported as a notebook with -the same basename, but an ``.ipynb`` extension, located in the notebook -directory. The notebook created will have just one cell, which will contain -all the code in the ``.py`` file. You can later manually partition this into -individual cells using the ``Edit | Split Cell`` menu option, or the +``.py`` files will be imported as a notebook with +the same basename, but an ``.ipynb`` extension, located in the notebook +directory. The notebook created will have just one cell, which will contain +all the code in the ``.py`` file. You can later manually partition this into +individual cells using the ``Edit | Split Cell`` menu option, or the :kbd:`Ctrl-m -` keyboard shortcut. Note that ``.py`` scripts obtained from a notebook document using :doc:`nbconvert ` @@ -486,17 +486,17 @@ script back into a notebook will preserve this structure. .. warning:: While in simple cases you can "roundtrip" a notebook to Python, edit the - Python file, and then import it back without loss of main content, this is + Python file, and then import it back without loss of main content, this is in general *not guaranteed to work*. First, there is extra metadata saved in the notebook that may not be saved to the ``.py`` format. And as the notebook format evolves in complexity, there will be attributes of the notebook that will not survive a roundtrip through the Python form. You should think of the Python format as a way to output a script version of a - notebook and the import capabilities as a way to load existing code to get + notebook and the import capabilities as a way to load existing code to get a notebook started. But the Python version is *not* an alternate notebook format. .. seealso:: :ref:`nbformat` -.. include:: ../links.txt +.. include:: links.txt diff --git a/docs/source/notebook/public_server.rst b/docs/source/public_server.rst similarity index 100% rename from docs/source/notebook/public_server.rst rename to docs/source/public_server.rst diff --git a/docs/source/notebook/security.rst b/docs/source/security.rst similarity index 100% rename from docs/source/notebook/security.rst rename to docs/source/security.rst diff --git a/setup.py b/setup.py index 1c05f26c8d..895bed76e7 100755 --- a/setup.py +++ b/setup.py @@ -152,6 +152,7 @@ ] extras_require = { ':sys_platform != "win32"': ['terminado>=0.3.3'], + 'doc': ['Sphinx>=1.1'], 'test:python_version == "2.7"': ['mock'], 'test': ['nose', 'requests'], } @@ -162,14 +163,14 @@ setup_args['cmdclass']['develop'] = css_js_prerelease(develop) if not PY3: setup_args['setup_requires'] = ['ipython_genutils'] - + try: from wheel.bdist_wheel import bdist_wheel except ImportError: pass else: setup_args['cmdclass']['bdist_wheel'] = css_js_prerelease(bdist_wheel) - + setuptools_extra_args['zip_safe'] = False setup_args['extras_require'] = extras_require requires = setup_args['install_requires'] = install_requires