Merge pull request #4048 from minrk/finish-notes

finish up speaker-notes PR

This removes the special handling of speaker notes, simply informing the user that speaker notes require local require.js.

It also renames the alias name for reveal.js url prefix to something more descriptive (reveal-prefix).

.travis.yml

@@ -1,16 +1,14 b''
 # http://travis-ci.org/#!/ipython/ipython
 language: python
 python:
     - 2.7
     - 3.3
 before_install:
-    - pip install jinja2
     - easy_install -q pyzmq
+    - pip install jinja2 sphinx pygments tornado
     - sudo apt-get install pandoc
-    - pip install pygments
-    - pip install sphinx
 install:
     - python setup.py install -q 
 script:
     - if [[ $TRAVIS_PYTHON_VERSION == '2.'* ]]; then iptest -w /tmp; fi
     - if [[ $TRAVIS_PYTHON_VERSION == '3.'* ]]; then iptest3 -w /tmp; fi

IPython/nbconvert/nbconvertapp.py

@@ -1,324 +1,323 b''
 #!/usr/bin/env python
 """NBConvert is a utility for conversion of .ipynb files.
 
 Command-line interface for the NbConvert conversion utility.
 """
 #-----------------------------------------------------------------------------
 #Copyright (c) 2013, the IPython Development Team.
 #
 #Distributed under the terms of the Modified BSD License.
 #
 #The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 #Imports
 #-----------------------------------------------------------------------------
 
 # Stdlib imports
 from __future__ import print_function
 
 import logging
 import sys
 import os
 import glob
 
 # From IPython
 from IPython.core.application import BaseIPythonApplication, base_aliases, base_flags
 from IPython.core.profiledir import ProfileDir
 from IPython.config import catch_config_error, Configurable
 from IPython.utils.traitlets import (
     Unicode, List, Instance, DottedObjectName, Type, CaselessStrEnum,
 )
 from IPython.utils.importstring import import_item
 from IPython.utils.text import dedent
 
 from .exporters.export import get_export_names, exporter_map
 from IPython.nbconvert import exporters, preprocessors, writers, postprocessors
 from .utils.base import NbConvertBase
 from .utils.exceptions import ConversionException
 
 #-----------------------------------------------------------------------------
 #Classes and functions
 #-----------------------------------------------------------------------------
 
 class DottedOrNone(DottedObjectName):
     """
     A string holding a valid dotted object name in Python, such as A.b3._c
     Also allows for None type."""
     
     default_value = u''
 
     def validate(self, obj, value):
         if value is not None and len(value) > 0:
             return super(DottedOrNone, self).validate(obj, value)
         else:
             return value
             
 nbconvert_aliases = {}
 nbconvert_aliases.update(base_aliases)
 nbconvert_aliases.update({
     'to' : 'NbConvertApp.export_format',
     'template' : 'Exporter.template_file',
     'writer' : 'NbConvertApp.writer_class',
     'post': 'NbConvertApp.postprocessor_class',
     'output': 'NbConvertApp.output_base',
-    'offline-slides': 'RevealHelpPreprocessor.url_prefix',
-    'slide-notes': 'RevealHelpPreprocessor.speaker_notes'
+    'reveal-prefix': 'RevealHelpPreprocessor.url_prefix',
 })
 
 nbconvert_flags = {}
 nbconvert_flags.update(base_flags)
 nbconvert_flags.update({
     'stdout' : (
         {'NbConvertApp' : {'writer_class' : "StdoutWriter"}},
         "Write notebook output to stdout instead of files."
         )
 })
 
 
 class NbConvertApp(BaseIPythonApplication):
     """Application used to convert to and from notebook file type (*.ipynb)"""
 
     name = 'ipython-nbconvert'
     aliases = nbconvert_aliases
     flags = nbconvert_flags
     
     def _log_level_default(self):
         return logging.INFO
     
     def _classes_default(self):
         classes = [NbConvertBase, ProfileDir]
         for pkg in (exporters, preprocessors, writers):
             for name in dir(pkg):
                 cls = getattr(pkg, name)
                 if isinstance(cls, type) and issubclass(cls, Configurable):
                     classes.append(cls)
         
         return classes
 
     description = Unicode(
         u"""This application is used to convert notebook files (*.ipynb)
         to various other formats.
 
         WARNING: THE COMMANDLINE INTERFACE MAY CHANGE IN FUTURE RELEASES.""")
 
     output_base = Unicode('', config=True, help='''overwrite base name use for output files.
             can only  be use when converting one notebook at a time.
             ''')
 
     examples = Unicode(u"""
         The simplest way to use nbconvert is
         
         > ipython nbconvert mynotebook.ipynb
         
         which will convert mynotebook.ipynb to the default format (probably HTML).
         
         You can specify the export format with `--to`.
         Options include {0}
         
         > ipython nbconvert --to latex mynotebook.ipnynb
 
         Both HTML and LaTeX support multiple output templates. LaTeX includes
         'basic', 'book', and 'article'.  HTML includes 'basic' and 'full'.  You 
         can specify the flavor of the format used.
 
         > ipython nbconvert --to html --template basic mynotebook.ipynb
         
         You can also pipe the output to stdout, rather than a file
         
         > ipython nbconvert mynotebook.ipynb --stdout
 
         A post-processor can be used to compile a PDF
 
         > ipython nbconvert mynotebook.ipynb --to latex --post PDF
         
         You can get (and serve) a Reveal.js-powered slideshow
         
         > ipython nbconvert myslides.ipynb --to slides --post serve
         
         Multiple notebooks can be given at the command line in a couple of 
         different ways:
   
         > ipython nbconvert notebook*.ipynb
         > ipython nbconvert notebook1.ipynb notebook2.ipynb
         
         or you can specify the notebooks list in a config file, containing::
         
             c.NbConvertApp.notebooks = ["my_notebook.ipynb"]
         
         > ipython nbconvert --config mycfg.py
         """.format(get_export_names()))
 
     # Writer specific variables
     writer = Instance('IPython.nbconvert.writers.base.WriterBase',  
                       help="""Instance of the writer class used to write the 
                       results of the conversion.""")
     writer_class = DottedObjectName('FilesWriter', config=True, 
                                     help="""Writer class used to write the 
                                     results of the conversion""")
     writer_aliases = {'fileswriter': 'IPython.nbconvert.writers.files.FilesWriter',
                       'debugwriter': 'IPython.nbconvert.writers.debug.DebugWriter',
                       'stdoutwriter': 'IPython.nbconvert.writers.stdout.StdoutWriter'}
     writer_factory = Type()
 
     def _writer_class_changed(self, name, old, new):
         if new.lower() in self.writer_aliases:
             new = self.writer_aliases[new.lower()]
         self.writer_factory = import_item(new)
 
     # Post-processor specific variables
     postprocessor = Instance('IPython.nbconvert.postprocessors.base.PostProcessorBase',  
                       help="""Instance of the PostProcessor class used to write the 
                       results of the conversion.""")
 
     postprocessor_class = DottedOrNone(config=True, 
                                     help="""PostProcessor class used to write the 
                                     results of the conversion""")
     postprocessor_aliases = {'pdf': 'IPython.nbconvert.postprocessors.pdf.PDFPostProcessor',
                               'serve': 'IPython.nbconvert.postprocessors.serve.ServePostProcessor'}
     postprocessor_factory = Type()
 
     def _postprocessor_class_changed(self, name, old, new):
         if new.lower() in self.postprocessor_aliases:
             new = self.postprocessor_aliases[new.lower()]
         if new:
             self.postprocessor_factory = import_item(new)
 
 
     # Other configurable variables
     export_format = CaselessStrEnum(get_export_names(),
         default_value="html",
         config=True,
         help="""The export format to be used."""
     )
 
     notebooks = List([], config=True, help="""List of notebooks to convert.
                      Wildcards are supported.
                      Filenames passed positionally will be added to the list.
                      """)
 
     @catch_config_error
     def initialize(self, argv=None):
         super(NbConvertApp, self).initialize(argv)
         self.init_syspath()
         self.init_notebooks()
         self.init_writer()
         self.init_postprocessor()
 
 
 
     def init_syspath(self):
         """
         Add the cwd to the sys.path ($PYTHONPATH)
         """
         sys.path.insert(0, os.getcwd())
         
 
     def init_notebooks(self):
         """Construct the list of notebooks.
         If notebooks are passed on the command-line,
         they override notebooks specified in config files.
         Glob each notebook to replace notebook patterns with filenames.
         """
 
         # Specifying notebooks on the command-line overrides (rather than adds)
         # the notebook list
         if self.extra_args:
             patterns = self.extra_args
         else:
             patterns = self.notebooks
 
         # Use glob to replace all the notebook patterns with filenames.
         filenames = []
         for pattern in patterns:
             
             # Use glob to find matching filenames.  Allow the user to convert 
             # notebooks without having to type the extension.
             globbed_files = glob.glob(pattern)
             globbed_files.extend(glob.glob(pattern + '.ipynb'))
             if not globbed_files:
                 self.log.warn("pattern %r matched no files", pattern)
 
             for filename in globbed_files:
                 if not filename in filenames:
                     filenames.append(filename)
         self.notebooks = filenames
 
     def init_writer(self):
         """
         Initialize the writer (which is stateless)
         """
         self._writer_class_changed(None, self.writer_class, self.writer_class)
         self.writer = self.writer_factory(parent=self)
 
     def init_postprocessor(self):
         """
         Initialize the postprocessor (which is stateless)
         """
         self._postprocessor_class_changed(None, self.postprocessor_class, 
             self.postprocessor_class)
         if self.postprocessor_factory:
             self.postprocessor = self.postprocessor_factory(parent=self)
 
     def start(self):
         """
         Ran after initialization completed
         """
         super(NbConvertApp, self).start()
         self.convert_notebooks()
 
     def convert_notebooks(self):
         """
         Convert the notebooks in the self.notebook traitlet
         """
         # Export each notebook
         conversion_success = 0
 
         if self.output_base != '' and len(self.notebooks) > 1:
             self.log.error(
             """UsageError: --output flag or `NbConvertApp.output_base` config option
             cannot be used when converting multiple notebooks.
             """)
             self.exit(1)
         
         exporter = exporter_map[self.export_format](config=self.config)
 
         for notebook_filename in self.notebooks:
             self.log.info("Converting notebook %s to %s", notebook_filename, self.export_format)
 
             # Get a unique key for the notebook and set it in the resources object.
             basename = os.path.basename(notebook_filename)
             notebook_name = basename[:basename.rfind('.')]
             if self.output_base:
                 notebook_name = self.output_base
             resources = {}
             resources['unique_key'] = notebook_name
             resources['output_files_dir'] = '%s_files' % notebook_name
             self.log.info("Support files will be in %s", os.path.join(resources['output_files_dir'], ''))
 
             # Try to export
             try:
                 output, resources = exporter.from_filename(notebook_filename, resources=resources)
             except ConversionException as e:
                 self.log.error("Error while converting '%s'", notebook_filename,
                       exc_info=True)
                 self.exit(1)
             else:
                 write_resultes = self.writer.write(output, resources, notebook_name=notebook_name)
 
                 #Post-process if post processor has been defined.
                 if hasattr(self, 'postprocessor') and self.postprocessor:
                     self.postprocessor(write_resultes)
                 conversion_success += 1
 
         # If nothing was converted successfully, help the user.
         if conversion_success == 0:
             self.print_help()
             sys.exit(-1)
             
 #-----------------------------------------------------------------------------
 # Main entry point
 #-----------------------------------------------------------------------------
 
 launch_new_instance = NbConvertApp.launch_instance

IPython/nbconvert/postprocessors/__init__.py

@@ -1,3 +1,8 b''
 from .base import PostProcessorBase
 from .pdf import PDFPostProcessor
-from .serve import ServePostProcessor
+
+# protect against unavailable tornado
+try:
+    from .serve import ServePostProcessor
+except ImportError:
+    pass

IPython/nbconvert/postprocessors/serve.py

@@ -1,55 +1,107 b''
-"""
-Contains postprocessor for serving nbconvert output.
-"""
+"""PostProcessor for serving reveal.js HTML slideshows."""
 #-----------------------------------------------------------------------------
 #Copyright (c) 2013, the IPython Development Team.
 #
 #Distributed under the terms of the Modified BSD License.
 #
 #The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import os
 import webbrowser
 
-from BaseHTTPServer import HTTPServer
-from SimpleHTTPServer import SimpleHTTPRequestHandler
+from tornado import web, ioloop, httpserver
+from tornado.httpclient import AsyncHTTPClient
 
-from IPython.utils.traitlets import Bool
+from IPython.utils.traitlets import Bool, Unicode, Int
 
 from .base import PostProcessorBase
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
+
+class ProxyHandler(web.RequestHandler):
+    """handler the proxies requests from a local prefix to a CDN"""
+    @web.asynchronous
+    def get(self, prefix, url):
+        """proxy a request to a CDN"""
+        proxy_url = "/".join([self.settings['cdn'], url])
+        client = self.settings['client']
+        client.fetch(proxy_url, callback=self.finish_get)
+    
+    def finish_get(self, response):
+        """finish the request"""
+        # copy potentially relevant headers
+        for header in ["Content-Type", "Cache-Control", "Date", "Last-Modified", "Expires"]:
+            if header in response.headers:
+                self.set_header(header, response.headers[header])
+        self.finish(response.body)
+
 class ServePostProcessor(PostProcessorBase):
-    """Post processor designed to serve files"""
+    """Post processor designed to serve files
+    
+    Proxies reveal.js requests to a CDN if no local reveal.js is present
+    """
 
 
     open_in_browser = Bool(True, config=True,
-                           help="""Set to False to deactivate
-                           the opening of the browser""")
+        help="""Should the browser be opened automatically?"""
+    )
+    reveal_cdn = Unicode("https://cdn.jsdelivr.net/reveal.js/2.4.0", config=True,
+        help="""URL for reveal.js CDN."""
+    )
+    reveal_prefix = Unicode("reveal.js", config=True, help="URL prefix for reveal.js")
+    ip = Unicode("127.0.0.1", config=True, help="The IP address to listen on.")
+    port = Int(8000, config=True, help="port for the server to listen on.")
 
     def postprocess(self, input):
-        """
-        Simple implementation to serve the build directory.
-        """
-
+        """Serve the build directory with a webserver."""
+        dirname, filename = os.path.split(input)
+        handlers = [
+            (r"/(.+)", web.StaticFileHandler, {'path' : dirname}),
+            (r"/", web.RedirectHandler, {"url": "/%s" % filename})
+        ]
+        
+        if ('://' in self.reveal_prefix or self.reveal_prefix.startswith("//")):
+            # reveal specifically from CDN, nothing to do
+            pass
+        elif os.path.isdir(os.path.join(dirname, self.reveal_prefix)):
+            # reveal prefix exists
+            self.log.info("Serving local %s", self.reveal_prefix)
+        else:
+            self.log.info("Redirecting %s requests to %s", self.reveal_prefix, self.reveal_cdn)
+            handlers.insert(0, (r"/(%s)/(.*)" % self.reveal_prefix, ProxyHandler))
+        
+        app = web.Application(handlers,
+            cdn=self.reveal_cdn,
+            client=AsyncHTTPClient(),
+        )
+        # hook up tornado logging to our logger
+        from tornado import log
+        log.app_log = self.log
+    
+        http_server = httpserver.HTTPServer(app)
+        http_server.listen(self.port, address=self.ip)
+        url = "http://%s:%i/%s" % (self.ip, self.port, filename)
+        print("Serving your slides at %s" % url)
+        print("Use Control-C to stop this server")
+        if self.open_in_browser:
+            webbrowser.open(url, new=2)
         try:
-            dirname, filename = os.path.split(input)
-            if dirname:
-                os.chdir(dirname)
-            httpd = HTTPServer(('127.0.0.1', 8000), SimpleHTTPRequestHandler)
-            sa = httpd.socket.getsockname()
-            url = "http://" + sa[0] + ":" + str(sa[1]) + "/" + filename
-            if self.open_in_browser:
-                webbrowser.open(url, new=2)
-            print("Serving your slides on " + url)
-            print("Use Control-C to stop this server.")
-            httpd.serve_forever()
+            ioloop.IOLoop.instance().start()
         except KeyboardInterrupt:
-            print("The server is shut down.")
+            print("\nInterrupted")
+
+def main(path):
+    """allow running this module to serve the slides"""
+    server = ServePostProcessor()
+    server(path)
+    
+if __name__ == '__main__':
+    import sys
+    main(sys.argv[1])

IPython/nbconvert/preprocessors/revealhelp.py

@@ -1,94 +1,67 b''
 """Module that pre-processes the notebook for export via Reveal.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import os
 import urllib2
 
 from .base import Preprocessor
 from IPython.utils.traitlets import Unicode, Bool
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 class RevealHelpPreprocessor(Preprocessor):
 
-    url_prefix = Unicode('//cdn.jsdelivr.net/reveal.js/2.4.0',
-                         config=True,
-                         help="""If you want to use a local reveal.js library,
-                         use 'url_prefix':'reveal.js' in your config object.""")
-
-    speaker_notes = Bool(False, 
-                         config=True, 
-                         help="""If you want to use the speaker notes 
-                         set this to True.""")
+    url_prefix = Unicode('reveal.js', config=True,
+                         help="""The URL prefix for reveal.js.
+                         This can be a a relative URL for a local copy of reveal.js,
+                         or point to a CDN.
+                         
+                         For speaker notes to work, a local reveal.js prefix must be used.
+                         """
+    )
 
     def preprocess(self, nb, resources):
         """
         Called once to 'preprocess' contents of the notebook.
 
         Parameters
         ----------
         nb : NotebookNode
             Notebook being converted
         resources : dictionary
             Additional resources used in the conversion process.  Allows
             preprocessors to pass variables into the Jinja engine.
         """
 
         for worksheet in nb.worksheets :
             for index, cell in enumerate(worksheet.cells):
 
                 #Make sure the cell has slideshow metadata.
                 cell.metadata.align_type = cell.get('metadata', {}).get('slideshow', {}).get('align_type', 'Left')
                 cell.metadata.slide_type = cell.get('metadata', {}).get('slideshow', {}).get('slide_type', '-')
 
                 #Get the slide type.  If type is start of subslide or slide,
                 #end the last subslide/slide.
                 if cell.metadata.slide_type in ['slide']:
                     worksheet.cells[index - 1].metadata.slide_helper = 'slide_end'
                 if cell.metadata.slide_type in ['subslide']:
                     worksheet.cells[index - 1].metadata.slide_helper = 'subslide_end'
 
 
         if not isinstance(resources['reveal'], dict):
             resources['reveal'] = {}
         resources['reveal']['url_prefix'] = self.url_prefix
-        resources['reveal']['notes_prefix'] = self.url_prefix
-
-        cdn = 'http://cdn.jsdelivr.net/reveal.js/2.4.0'
-        local = 'local'
-        html_path = 'plugin/notes/notes.html'
-        js_path = 'plugin/notes/notes.js'
-
-        html_infile = os.path.join(cdn, html_path)
-        js_infile = os.path.join(cdn, js_path)
-        html_outfile = os.path.join(local, html_path)
-        js_outfile = os.path.join(local, js_path)
-
-        if self.speaker_notes:
-            if 'outputs' not in resources:
-                resources['outputs'] = {}
-            resources['outputs'][html_outfile] = self.notes_helper(html_infile)
-            resources['outputs'][js_outfile] = self.notes_helper(js_infile)
-            resources['reveal']['notes_prefix'] = local
-
         return nb, resources
-
-    def notes_helper(self, infile):
-        """Helper function to get the content from an url."""
-
-        content = urllib2.urlopen(infile).read()
-
-        return content

IPython/nbconvert/templates/slides_reveal.tpl

@@ -1,185 +1,185 b''
 {%- extends 'reveal_internals/slides.tpl' -%}
 
 
 {% block header %}
 <!DOCTYPE html>
 <html>
 <head>
 
 <meta charset="utf-8" />
 <meta http-equiv="X-UA-Compatible" content="chrome=1">
 
 <meta name="apple-mobile-web-app-capable" content="yes" />
 <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
 
 <!-- General and theme style sheets -->
 <link rel="stylesheet" href="{{resources.reveal.url_prefix}}/css/reveal.css">
 <link rel="stylesheet" href="{{resources.reveal.url_prefix}}/css/theme/simple.css" id="theme">
 
 <!-- For syntax highlighting -->
 <link rel="stylesheet" href="{{resources.reveal.url_prefix}}/lib/css/zenburn.css">
 
 <!-- If the query includes 'print-pdf', use the PDF print sheet -->
 <script>
 document.write( '<link rel="stylesheet" href="{{resources.reveal.url_prefix}}/css/print/' + ( window.location.search.match( /print-pdf/gi ) ? 'pdf' : 'paper' ) + '.css" type="text/css" media="print">' );
 </script>
 
 <!--[if lt IE 9]>
 <script src="{{resources.reveal.url_prefix}}/lib/js/html5shiv.js"></script>
 <![endif]-->
 
 {% for css in resources.inlining.css -%}
     <style type="text/css">
     {{ css }}
     </style>
 {% endfor %}
 
 <style type="text/css">
 /* Overrides of notebook CSS for static HTML export */
 .reveal {
 font-size: 20px;
 overflow-y: auto;
 overflow-x: hidden;
 }
 .reveal pre {
 width: 95%;
 padding: 0.4em;
 margin: 0px;
 font-family: monospace, sans-serif;
 font-size: 80%;
 box-shadow: 0px 0px 0px rgba(0, 0, 0, 0);
 }
 .reveal section img {
 border: 0px solid black;
 box-shadow: 0 0 10px rgba(0, 0, 0, 0);
 }
 .reveal .slides {
 text-align: left;
 }
 .reveal.fade {
 opacity: 1;
 }
 div.input_area {
 padding: 0.06em;
 }
 div.code_cell {
 background-color: transparent;
 }
 div.prompt {
 width: 11ex;
 padding: 0.4em;
 margin: 0px;
 font-family: monospace, sans-serif;
 font-size: 80%;
 text-align: right;
 }
 div.output_area pre {
 font-family: monospace, sans-serif;
 font-size: 80%;
 }
 div.output_prompt {
     /* 5px right shift to account for margin in parent container */
     margin: 5px 5px 0 0;
 }
 .rendered_html p {
 text-align: inherit;
 }
 </style>
 
 <!-- Custom stylesheet, it must be in the same directory as the html file -->
 <link rel="stylesheet" href="custom.css">
 
 </head>
 {% endblock header%}
 
 
 {% block body %}
 <body>
 <div class="reveal">
 <div class="slides">
 {{ super() }}
 </div>
 </div>
 
 <!--
 Uncomment the following block and the addthis_widget.js (see below inside dependencies)
 to get enable social buttons.
 -->
 
 <!--
 <div class="addthis_toolbox addthis_floating_style addthis_32x32_style" style="left:20px;top:20px;">
 <a class="addthis_button_twitter"></a>
 <a class="addthis_button_google_plusone_share"></a>
 <a class="addthis_button_linkedin"></a>
 <a class="addthis_button_facebook"></a>
 <a class="addthis_button_more"></a>
 </div>
 -->
 
 <script src="{{resources.reveal.url_prefix}}/lib/js/head.min.js"></script>
 
 <script src="{{resources.reveal.url_prefix}}/js/reveal.js"></script>
 
 <script>
 
 // Full list of configuration options available here: https://github.com/hakimel/reveal.js#configuration
 Reveal.initialize({
 controls: true,
 progress: true,
 history: true,
 
 theme: Reveal.getQueryHash().theme, // available themes are in /css/theme
 transition: Reveal.getQueryHash().transition || 'linear', // default/cube/page/concave/zoom/linear/none
 
 // Optional libraries used to extend on reveal.js
 dependencies: [
 { src: "{{resources.reveal.url_prefix}}/lib/js/classList.js", condition: function() { return !document.body.classList; } },
 { src: "{{resources.reveal.url_prefix}}/plugin/highlight/highlight.js", async: true, callback: function() { hljs.initHighlightingOnLoad(); } },
-{ src: "{{resources.reveal.notes_prefix}}/plugin/notes/notes.js", async: true, condition: function() { return !!document.body.classList; } }
+{ src: "{{resources.reveal.url_prefix}}/plugin/notes/notes.js", async: true, condition: function() { return !!document.body.classList; } }
 // { src: 'http://s7.addthis.com/js/300/addthis_widget.js', async: true},
 ]
 });
 </script>
 
 <!-- MathJax configuration -->
 <script type="text/x-mathjax-config">
 MathJax.Hub.Config({
     tex2jax: {
         inlineMath: [ ['$','$'], ["\\(","\\)"] ],
         displayMath: [ ['$$','$$'], ["\\[","\\]"] ]
     },
     displayAlign: 'left', // Change this to 'center' to center equations.
     "HTML-CSS": {
         styles: {'.MathJax_Display': {"margin": 0}}
     }
 });
 </script>
 <!-- End of mathjax configuration -->
 
 <script>
 //  We wait for the onload function to load MathJax after the page is completely loaded.
 //  MathJax is loaded 1 unit of time after the page is ready.
 //  This hack prevent problems when you load multiple js files (i.e. social button from addthis).
 //
 window.onload = function () {
   setTimeout(function () {
     var script = document.createElement("script");
     script.type = "text/javascript";
     script.src  = "https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS_HTML";
     document.getElementsByTagName("head")[0].appendChild(script);
   },1)
 }
 </script>
 
 <script>
 Reveal.addEventListener( 'slidechanged', function( event ) {
 MathJax.Hub.Rerender(event.currentSlide);
 });
 </script>
 
 </body>
 {% endblock body %}
 
 {% block footer %}
 </html>
 {% endblock footer %}
  No newline at end of file

IPython/testing/iptest.py

@@ -1,654 +1,656 b''
 # -*- coding: utf-8 -*-
 """IPython Test Suite Runner.
 
 This module provides a main entry point to a user script to test IPython
 itself from the command line. There are two ways of running this script:
 
 1. With the syntax `iptest all`.  This runs our entire test suite by
    calling this script (with different arguments) recursively.  This
    causes modules and package to be tested in different processes, using nose
    or trial where appropriate.
 2. With the regular nose syntax, like `iptest -vvs IPython`.  In this form
    the script simply calls nose, but with special command line flags and
    plugins loaded.
 
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2009-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from __future__ import print_function
 
 # Stdlib
 import glob
 import os
 import os.path as path
 import signal
 import sys
 import subprocess
 import tempfile
 import time
 import warnings
 import multiprocessing.pool
 
 # Now, proceed to import nose itself
 import nose.plugins.builtin
 from nose.plugins.xunit import Xunit
 from nose import SkipTest
 from nose.core import TestProgram
 
 # Our own imports
 from IPython.utils import py3compat
 from IPython.utils.importstring import import_item
 from IPython.utils.path import get_ipython_module_path, get_ipython_package_dir
 from IPython.utils.process import pycmd2argv
 from IPython.utils.sysinfo import sys_info
 from IPython.utils.tempdir import TemporaryDirectory
 from IPython.utils.warn import warn
 
 from IPython.testing import globalipapp
 from IPython.testing.plugin.ipdoctest import IPythonDoctest
 from IPython.external.decorators import KnownFailure, knownfailureif
 
 pjoin = path.join
 
 
 #-----------------------------------------------------------------------------
 # Globals
 #-----------------------------------------------------------------------------
 
 
 #-----------------------------------------------------------------------------
 # Warnings control
 #-----------------------------------------------------------------------------
 
 # Twisted generates annoying warnings with Python 2.6, as will do other code
 # that imports 'sets' as of today
 warnings.filterwarnings('ignore', 'the sets module is deprecated',
                         DeprecationWarning )
 
 # This one also comes from Twisted
 warnings.filterwarnings('ignore', 'the sha module is deprecated',
                         DeprecationWarning)
 
 # Wx on Fedora11 spits these out
 warnings.filterwarnings('ignore', 'wxPython/wxWidgets release number mismatch',
                         UserWarning)
 
 # ------------------------------------------------------------------------------
 # Monkeypatch Xunit to count known failures as skipped.
 # ------------------------------------------------------------------------------
 def monkeypatch_xunit():
     try:
         knownfailureif(True)(lambda: None)()
     except Exception as e:
         KnownFailureTest = type(e)
 
     def addError(self, test, err, capt=None):
         if issubclass(err[0], KnownFailureTest):
             err = (SkipTest,) + err[1:]
         return self.orig_addError(test, err, capt)
 
     Xunit.orig_addError = Xunit.addError
     Xunit.addError = addError
 
 #-----------------------------------------------------------------------------
 # Logic for skipping doctests
 #-----------------------------------------------------------------------------
 def extract_version(mod):
     return mod.__version__
 
 def test_for(item, min_version=None, callback=extract_version):
     """Test to see if item is importable, and optionally check against a minimum
     version.
 
     If min_version is given, the default behavior is to check against the
     `__version__` attribute of the item, but specifying `callback` allows you to
     extract the value you are interested in. e.g::
 
         In [1]: import sys
 
         In [2]: from IPython.testing.iptest import test_for
 
         In [3]: test_for('sys', (2,6), callback=lambda sys: sys.version_info)
         Out[3]: True
 
     """
     try:
         check = import_item(item)
     except (ImportError, RuntimeError):
         # GTK reports Runtime error if it can't be initialized even if it's
         # importable.
         return False
     else:
         if min_version:
             if callback:
                 # extra processing step to get version to compare
                 check = callback(check)
 
             return check >= min_version
         else:
             return True
 
 # Global dict where we can store information on what we have and what we don't
 # have available at test run time
 have = {}
 
 have['curses'] = test_for('_curses')
 have['matplotlib'] = test_for('matplotlib')
 have['numpy'] = test_for('numpy')
 have['pexpect'] = test_for('IPython.external.pexpect')
 have['pymongo'] = test_for('pymongo')
 have['pygments'] = test_for('pygments')
 have['qt'] = test_for('IPython.external.qt')
 have['rpy2'] = test_for('rpy2')
 have['sqlite3'] = test_for('sqlite3')
 have['cython'] = test_for('Cython')
 have['oct2py'] = test_for('oct2py')
 have['tornado'] = test_for('tornado.version_info', (2,1,0), callback=None)
 have['jinja2'] = test_for('jinja2')
 have['wx'] = test_for('wx')
 have['wx.aui'] = test_for('wx.aui')
 have['azure'] = test_for('azure')
 have['sphinx'] = test_for('sphinx')
 
 min_zmq = (2,1,11)
 
 have['zmq'] = test_for('zmq.pyzmq_version_info', min_zmq, callback=lambda x: x())
 
 #-----------------------------------------------------------------------------
 # Functions and classes
 #-----------------------------------------------------------------------------
 
 def report():
     """Return a string with a summary report of test-related variables."""
 
     out = [ sys_info(), '\n']
 
     avail = []
     not_avail = []
 
     for k, is_avail in have.items():
         if is_avail:
             avail.append(k)
         else:
             not_avail.append(k)
 
     if avail:
         out.append('\nTools and libraries available at test time:\n')
         avail.sort()
         out.append('   ' + ' '.join(avail)+'\n')
 
     if not_avail:
         out.append('\nTools and libraries NOT available at test time:\n')
         not_avail.sort()
         out.append('   ' + ' '.join(not_avail)+'\n')
 
     return ''.join(out)
 
 
 def make_exclude():
     """Make patterns of modules and packages to exclude from testing.
 
     For the IPythonDoctest plugin, we need to exclude certain patterns that
     cause testing problems.  We should strive to minimize the number of
     skipped modules, since this means untested code.
 
     These modules and packages will NOT get scanned by nose at all for tests.
     """
     # Simple utility to make IPython paths more readably, we need a lot of
     # these below
     ipjoin = lambda *paths: pjoin('IPython', *paths)
 
     exclusions = [ipjoin('external'),
                   ipjoin('quarantine'),
                   ipjoin('deathrow'),
                   # This guy is probably attic material
                   ipjoin('testing', 'mkdoctests'),
                   # Testing inputhook will need a lot of thought, to figure out
                   # how to have tests that don't lock up with the gui event
                   # loops in the picture
                   ipjoin('lib', 'inputhook'),
                   # Config files aren't really importable stand-alone
                   ipjoin('config', 'profile'),
                   # The notebook 'static' directory contains JS, css and other
                   # files for web serving.  Occasionally projects may put a .py
                   # file in there (MathJax ships a conf.py), so we might as
                   # well play it safe and skip the whole thing.
                   ipjoin('html', 'static'),
                   ipjoin('html', 'fabfile'),
                   ]
     if not have['sqlite3']:
         exclusions.append(ipjoin('core', 'tests', 'test_history'))
         exclusions.append(ipjoin('core', 'history'))
     if not have['wx']:
         exclusions.append(ipjoin('lib', 'inputhookwx'))
     
     if 'IPython.kernel.inprocess' not in sys.argv:
         exclusions.append(ipjoin('kernel', 'inprocess'))
     
     # FIXME: temporarily disable autoreload tests, as they can produce
     # spurious failures in subsequent tests (cythonmagic).
     exclusions.append(ipjoin('extensions', 'autoreload'))
     exclusions.append(ipjoin('extensions', 'tests', 'test_autoreload'))
 
     # We do this unconditionally, so that the test suite doesn't import
     # gtk, changing the default encoding and masking some unicode bugs.
     exclusions.append(ipjoin('lib', 'inputhookgtk'))
     exclusions.append(ipjoin('kernel', 'zmq', 'gui', 'gtkembed'))
 
     #Also done unconditionally, exclude nbconvert directories containing
     #config files used to test.  Executing the config files with iptest would
     #cause an exception.
     exclusions.append(ipjoin('nbconvert', 'tests', 'files'))
     exclusions.append(ipjoin('nbconvert', 'exporters', 'tests', 'files'))
 
     # These have to be skipped on win32 because the use echo, rm, cd, etc.
     # See ticket https://github.com/ipython/ipython/issues/87
     if sys.platform == 'win32':
         exclusions.append(ipjoin('testing', 'plugin', 'test_exampleip'))
         exclusions.append(ipjoin('testing', 'plugin', 'dtexample'))
 
     if not have['pexpect']:
         exclusions.extend([ipjoin('lib', 'irunner'),
                            ipjoin('lib', 'tests', 'test_irunner'),
                            ipjoin('terminal', 'console'),
                            ])
 
     if not have['zmq']:
         exclusions.append(ipjoin('lib', 'kernel'))
         exclusions.append(ipjoin('kernel'))
         exclusions.append(ipjoin('qt'))
         exclusions.append(ipjoin('html'))
         exclusions.append(ipjoin('consoleapp.py'))
         exclusions.append(ipjoin('terminal', 'console'))
         exclusions.append(ipjoin('parallel'))
     elif not have['qt'] or not have['pygments']:
         exclusions.append(ipjoin('qt'))
 
     if not have['pymongo']:
         exclusions.append(ipjoin('parallel', 'controller', 'mongodb'))
         exclusions.append(ipjoin('parallel', 'tests', 'test_mongodb'))
 
     if not have['matplotlib']:
         exclusions.extend([ipjoin('core', 'pylabtools'),
                            ipjoin('core', 'tests', 'test_pylabtools'),
                            ipjoin('kernel', 'zmq', 'pylab'),
         ])
 
     if not have['cython']:
         exclusions.extend([ipjoin('extensions', 'cythonmagic')])
         exclusions.extend([ipjoin('extensions', 'tests', 'test_cythonmagic')])
 
     if not have['oct2py']:
         exclusions.extend([ipjoin('extensions', 'octavemagic')])
         exclusions.extend([ipjoin('extensions', 'tests', 'test_octavemagic')])
 
     if not have['tornado']:
         exclusions.append(ipjoin('html'))
+        exclusions.append(ipjoin('nbconvert', 'post_processors', 'serve'))
+        exclusions.append(ipjoin('nbconvert', 'post_processors', 'tests', 'test_serve'))
 
     if not have['jinja2']:
         exclusions.append(ipjoin('html', 'notebookapp'))
 
     if not have['rpy2'] or not have['numpy']:
         exclusions.append(ipjoin('extensions', 'rmagic'))
         exclusions.append(ipjoin('extensions', 'tests', 'test_rmagic'))
 
     if not have['azure']:
         exclusions.append(ipjoin('html', 'services', 'notebooks', 'azurenbmanager'))
 
     if not all((have['pygments'], have['jinja2'], have['sphinx'])):
         exclusions.append(ipjoin('nbconvert'))
 
     # This is needed for the reg-exp to match on win32 in the ipdoctest plugin.
     if sys.platform == 'win32':
         exclusions = [s.replace('\\','\\\\') for s in exclusions]
     
     # check for any exclusions that don't seem to exist:
     parent, _ = os.path.split(get_ipython_package_dir())
     for exclusion in exclusions:
         if exclusion.endswith(('deathrow', 'quarantine')):
             # ignore deathrow/quarantine, which exist in dev, but not install
             continue
         fullpath = pjoin(parent, exclusion)
         if not os.path.exists(fullpath) and not glob.glob(fullpath + '.*'):
             warn("Excluding nonexistent file: %r" % exclusion)
 
     return exclusions
 
 
 class IPTester(object):
     """Call that calls iptest or trial in a subprocess.
     """
     #: string, name of test runner that will be called
     runner = None
     #: list, parameters for test runner
     params = None
     #: list, arguments of system call to be made to call test runner
     call_args = None
     #: list, subprocesses we start (for cleanup)
     processes = None
     #: str, coverage xml output file
     coverage_xml = None
     buffer_output = False
 
     def __init__(self, runner='iptest', params=None):
         """Create new test runner."""
         p = os.path
         if runner == 'iptest':
             iptest_app = os.path.abspath(get_ipython_module_path('IPython.testing.iptest'))
             self.runner = pycmd2argv(iptest_app) + sys.argv[1:]
         else:
             raise Exception('Not a valid test runner: %s' % repr(runner))
         if params is None:
             params = []
         if isinstance(params, str):
             params = [params]
         self.params = params
 
         # Assemble call
         self.call_args = self.runner+self.params
         
         # Find the section we're testing (IPython.foo)
         for sect in self.params:
             if sect.startswith('IPython') or sect in special_test_suites: break
         else:
             raise ValueError("Section not found", self.params)
         
         if '--with-xunit' in self.call_args:
             
             self.call_args.append('--xunit-file')
             # FIXME: when Windows uses subprocess.call, these extra quotes are unnecessary:
             xunit_file = path.abspath(sect+'.xunit.xml')
             if sys.platform == 'win32':
                 xunit_file = '"%s"' % xunit_file
             self.call_args.append(xunit_file)
         
         if '--with-xml-coverage' in self.call_args:
             self.coverage_xml = path.abspath(sect+".coverage.xml")
             self.call_args.remove('--with-xml-coverage')
             self.call_args = ["coverage", "run", "--source="+sect] + self.call_args[1:]
 
         # Store anything we start to clean up on deletion
         self.processes = []
 
     def _run_cmd(self):
         with TemporaryDirectory() as IPYTHONDIR:
             env = os.environ.copy()
             env['IPYTHONDIR'] = IPYTHONDIR
             # print >> sys.stderr, '*** CMD:', ' '.join(self.call_args) # dbg
             output = subprocess.PIPE if self.buffer_output else None
             subp = subprocess.Popen(self.call_args, stdout=output,
                     stderr=output, env=env)
             self.processes.append(subp)
             # If this fails, the process will be left in self.processes and
             # cleaned up later, but if the wait call succeeds, then we can
             # clear the stored process.
             retcode = subp.wait()
             self.processes.pop()
             self.stdout = subp.stdout
             self.stderr = subp.stderr
             return retcode
 
     def run(self):
         """Run the stored commands"""
         try:
             retcode = self._run_cmd()
         except KeyboardInterrupt:
             return -signal.SIGINT
         except:
             import traceback
             traceback.print_exc()
             return 1  # signal failure
         
         if self.coverage_xml:
             subprocess.call(["coverage", "xml", "-o", self.coverage_xml])
         return retcode
 
     def __del__(self):
         """Cleanup on exit by killing any leftover processes."""
         for subp in self.processes:
             if subp.poll() is not None:
                 continue # process is already dead
 
             try:
                 print('Cleaning up stale PID: %d' % subp.pid)
                 subp.kill()
             except: # (OSError, WindowsError) ?
                 # This is just a best effort, if we fail or the process was
                 # really gone, ignore it.
                 pass
             else:
                 for i in range(10):
                     if subp.poll() is None:
                         time.sleep(0.1)
                     else:
                         break
 
             if subp.poll() is None:
                 # The process did not die...
                 print('... failed. Manual cleanup may be required.')
 
 
 special_test_suites = {
     'autoreload': ['IPython.extensions.autoreload', 'IPython.extensions.tests.test_autoreload'],
 }
                 
 def make_runners(inc_slow=False):
     """Define the top-level packages that need to be tested.
     """
 
     # Packages to be tested via nose, that only depend on the stdlib
     nose_pkg_names = ['config', 'core', 'extensions', 'lib', 'terminal',
                       'testing', 'utils', 'nbformat']
 
     if have['qt']:
         nose_pkg_names.append('qt')
 
     if have['tornado']:
         nose_pkg_names.append('html')
         
     if have['zmq']:
         nose_pkg_names.insert(0, 'kernel')
         nose_pkg_names.insert(1, 'kernel.inprocess')
         if inc_slow:
             nose_pkg_names.insert(0, 'parallel')
 
     if all((have['pygments'], have['jinja2'], have['sphinx'])):
         nose_pkg_names.append('nbconvert')
 
     # For debugging this code, only load quick stuff
     #nose_pkg_names = ['core', 'extensions']  # dbg
 
     # Make fully qualified package names prepending 'IPython.' to our name lists
     nose_packages = ['IPython.%s' % m for m in nose_pkg_names ]
 
     # Make runners
     runners = [ (v, IPTester('iptest', params=v)) for v in nose_packages ]
     
     for name in special_test_suites:
         runners.append((name, IPTester('iptest', params=name)))
 
     return runners
 
 
 def run_iptest():
     """Run the IPython test suite using nose.
 
     This function is called when this script is **not** called with the form
     `iptest all`.  It simply calls nose with appropriate command line flags
     and accepts all of the standard nose arguments.
     """
     # Apply our monkeypatch to Xunit
     if '--with-xunit' in sys.argv and not hasattr(Xunit, 'orig_addError'):
         monkeypatch_xunit()
 
     warnings.filterwarnings('ignore',
         'This will be removed soon.  Use IPython.testing.util instead')
     
     if sys.argv[1] in special_test_suites:
         sys.argv[1:2] = special_test_suites[sys.argv[1]]
         special_suite = True
     else:
         special_suite = False
 
     argv = sys.argv + [ '--detailed-errors',  # extra info in tracebacks
 
                         '--with-ipdoctest',
                         '--ipdoctest-tests','--ipdoctest-extension=txt',
 
                         # We add --exe because of setuptools' imbecility (it
                         # blindly does chmod +x on ALL files).  Nose does the
                         # right thing and it tries to avoid executables,
                         # setuptools unfortunately forces our hand here.  This
                         # has been discussed on the distutils list and the
                         # setuptools devs refuse to fix this problem!
                         '--exe',
                         ]
     if '-a' not in argv and '-A' not in argv:
         argv = argv + ['-a', '!crash']
 
     if nose.__version__ >= '0.11':
         # I don't fully understand why we need this one, but depending on what
         # directory the test suite is run from, if we don't give it, 0 tests
         # get run.  Specifically, if the test suite is run from the source dir
         # with an argument (like 'iptest.py IPython.core', 0 tests are run,
         # even if the same call done in this directory works fine).  It appears
         # that if the requested package is in the current dir, nose bails early
         # by default.  Since it's otherwise harmless, leave it in by default
         # for nose >= 0.11, though unfortunately nose 0.10 doesn't support it.
         argv.append('--traverse-namespace')
 
     # use our plugin for doctesting.  It will remove the standard doctest plugin
     # if it finds it enabled
     ipdt = IPythonDoctest() if special_suite else IPythonDoctest(make_exclude())
     plugins = [ipdt, KnownFailure()]
     
     # We need a global ipython running in this process, but the special
     # in-process group spawns its own IPython kernels, so for *that* group we
     # must avoid also opening the global one (otherwise there's a conflict of
     # singletons).  Ultimately the solution to this problem is to refactor our
     # assumptions about what needs to be a singleton and what doesn't (app
     # objects should, individual shells shouldn't).  But for now, this
     # workaround allows the test suite for the inprocess module to complete.
     if not 'IPython.kernel.inprocess' in sys.argv:
         globalipapp.start_ipython()
 
     # Now nose can run
     TestProgram(argv=argv, addplugins=plugins)
 
 def do_run(x):
     print('IPython test group:',x[0])
     ret = x[1].run()
     return ret
 
 def run_iptestall(inc_slow=False, fast=False):
     """Run the entire IPython test suite by calling nose and trial.
 
     This function constructs :class:`IPTester` instances for all IPython
     modules and package and then runs each of them.  This causes the modules
     and packages of IPython to be tested each in their own subprocess using
     nose.
     
     Parameters
     ----------
     
     inc_slow : bool, optional
       Include slow tests, like IPython.parallel. By default, these tests aren't
       run.
 
     fast : bool, option
       Run the test suite in parallel, if True, using as many threads as there
       are processors
     """
     if fast:
         p = multiprocessing.pool.ThreadPool()
     else:
         p = multiprocessing.pool.ThreadPool(1)
 
     runners = make_runners(inc_slow=inc_slow)
 
     # Run the test runners in a temporary dir so we can nuke it when finished
     # to clean up any junk files left over by accident.  This also makes it
     # robust against being run in non-writeable directories by mistake, as the
     # temp dir will always be user-writeable.
     curdir = os.getcwdu()
     testdir = tempfile.gettempdir()
     os.chdir(testdir)
 
     # Run all test runners, tracking execution time
     failed = []
     t_start = time.time()
 
     try:
         all_res = p.map(do_run, runners)
         print('*'*70)
         for ((name, runner), res) in zip(runners, all_res):
             tgroup = 'IPython test group: ' + name
             res_string = 'OK' if res == 0 else 'FAILED'
             res_string = res_string.rjust(70 - len(tgroup), '.')
             print(tgroup + res_string)
             if res:
                 failed.append( (name, runner) )
                 if res == -signal.SIGINT:
                     print("Interrupted")
                     break
     finally:
         os.chdir(curdir)
     t_end = time.time()
     t_tests = t_end - t_start
     nrunners = len(runners)
     nfail = len(failed)
     # summarize results
     print()
     print('*'*70)
     print('Test suite completed for system with the following information:')
     print(report())
     print('Ran %s test groups in %.3fs' % (nrunners, t_tests))
     print()
     print('Status:')
     if not failed:
         print('OK')
     else:
         # If anything went wrong, point out what command to rerun manually to
         # see the actual errors and individual summary
         print('ERROR - %s out of %s test groups failed.' % (nfail, nrunners))
         for name, failed_runner in failed:
             print('-'*40)
             print('Runner failed:',name)
             print('You may wish to rerun this one individually, with:')
             failed_call_args = [py3compat.cast_unicode(x) for x in failed_runner.call_args]
             print(u' '.join(failed_call_args))
             print()
         # Ensure that our exit code indicates failure
         sys.exit(1)
 
 
 def main():
     for arg in sys.argv[1:]:
         if arg.startswith('IPython') or arg in special_test_suites:
             # This is in-process
             run_iptest()
     else:
         inc_slow =  "--all" in sys.argv
         if inc_slow:
             sys.argv.remove("--all")
 
         fast =  "--fast" in sys.argv
         if fast:
             sys.argv.remove("--fast")
             IPTester.buffer_output = True
 
         # This starts subprocesses
         run_iptestall(inc_slow=inc_slow, fast=fast)
 
 
 if __name__ == '__main__':
     main()

docs/source/interactive/nbconvert.rst

@@ -1,232 +1,227 b''
 .. _nbconvert:
 
 Converting notebooks to other formats
 =====================================
 
 Newly added in the 1.0 release of IPython is the ``nbconvert`` tool, which 
 allows you to convert an ``.ipynb`` notebook document file into various static 
 formats. 
 
 Currently, ``nbconvert`` is provided as a command line tool, run as a script 
 using IPython. A direct export capability from within the 
 IPython Notebook web app is planned. 
 
 The command-line syntax to run the ``nbconvert`` script is::
 
   $ ipython nbconvert --to FORMAT notebook.ipynb
 
 This will convert the IPython document file ``notebook.ipynb`` into the output 
 format given by the ``FORMAT`` string.
 
 The default output format is html, for which the ``--to`` argument may be 
 omitted::
   
   $ ipython nbconvert notebook.ipynb
 
 IPython provides a few templates for some output formats, and these can be
 specified via an additional ``--template`` argument.
 
 The currently supported export formats are:
 
 * ``--to html``
 
   - ``--template full`` (default)
   
     A full static HTML render of the notebook.
     This looks very similar to the interactive view.
 
   - ``--template basic``
   
     Simplified HTML, useful for embedding in webpages, blogs, etc.
     This excludes HTML headers.
 
 * ``--to latex``
 
   Latex export.  This generates ``NOTEBOOK_NAME.tex`` file,
   ready for export.  You can automatically run latex on it to generate a PDF
   by adding ``--post PDF``.
   
   - ``--template article`` (default)
   
     Latex article, derived from Sphinx's howto template.
 
   - ``--template book``
   
     Latex book, derived from Sphinx's manual template.
 
   - ``--template basic``
   
     Very basic latex output - mainly meant as a starting point for custom templates.
 
 * ``--to slides``
 
   This generates a Reveal.js HTML slideshow.
-  It must be served by an HTTP server.  The easiest way to get this is to add
+  It must be served by an HTTP server.  The easiest way to do this is adding
   ``--post serve`` on the command-line.
-  If you want to use the speaker notes plugin, just add
-  ``--slide-notes=True`` on the command-line.
-  For low connectivity environments, you can use a local copy of the reveal.js library, 
-  just add ``--offline-slides=reveal.js`` on the command-line, and do not forget to move
-  your downloaded ``reveal.js`` library to the same folder where your slides are located.
-  
+
 * ``--to markdown``
 
   Simple markdown output.  Markdown cells are unaffected,
   and code cells are placed in triple-backtick (```````) blocks.
 
 * ``--to rst``
 
   Basic reStructuredText output. Useful as a starting point for embedding notebooks
   in Sphinx docs.
 
 * ``--to python``
 
   Convert a notebook to an executable Python script.
   This is the simplest way to get a Python script out of a notebook.
   If there were any magics in the notebook, this may only be executable from
   an IPython session.
   
 .. note::
 
   nbconvert uses pandoc_ to convert between various markup languages,
   so pandoc is a dependency of most nbconvert transforms,
   excluding Markdown and Python.
 
 .. _pandoc: http://johnmacfarlane.net/pandoc/
 
 The output file created by ``nbconvert`` will have the same base name as
 the notebook and will be placed in the current working directory. Any
 supporting files (graphics, etc) will be placed in a new directory with the
 same base name as the notebook, suffixed with ``_files``::
 
   $ ipython nbconvert notebook.ipynb
   $ ls
   notebook.ipynb   notebook.html    notebook_files/
 
 For simple single-file output, such as html, markdown, etc.,
 the output may be sent to standard output with::
     
   $ ipython nbconvert --to markdown notebook.ipynb --stdout
     
 Multiple notebooks can be specified from the command line::
     
   $ ipython nbconvert notebook*.ipynb
   $ ipython nbconvert notebook1.ipynb notebook2.ipynb
     
 or via a list in a configuration file, say ``mycfg.py``, containing the text::
 
   c = get_config()
   c.NbConvertApp.notebooks = ["notebook1.ipynb", "notebook2.ipynb"]
 
 and using the command::
 
   $ ipython nbconvert --config mycfg.py
 
 
 .. _notebook_format:
 
 LaTeX citations
 ---------------
 
 ``nbconvert`` now has support for LaTeX citations. With this capability you
 can:
 
 * Manage citations using BibTeX.
 * Cite those citations in Markdown cells using HTML data attributes.
 * Have ``nbconvert`` generate proper LaTeX citations and run BibTeX.
 
 For an example of how this works, please see the citations example in
 the nbconvert-examples_ repository.
 
 .. _nbconvert-examples: https://github.com/ipython/nbconvert-examples
 
 Notebook JSON file format
 -------------------------
 
 Notebook documents are JSON files with an ``.ipynb`` extension, formatted
 as legibly as possible with minimal extra indentation and cell content broken
 across lines to make them reasonably friendly to use in version-control
 workflows.  You should be very careful if you ever manually edit this JSON
 data, as it is extremely easy to corrupt its internal structure and make the
 file impossible to load.  In general, you should consider the notebook as a
 file meant only to be edited by the IPython Notebook app itself, not for 
 hand-editing.
 
 .. note::
 
      Binary data such as figures are also saved directly in the JSON file.  
      This provides convenient single-file portability, but means that the 
      files can be large; a ``diff`` of binary data is also not very 
      meaningful.  Since the binary blobs are encoded in a single line, they 
      affect only one line of the ``diff`` output, but they are typically very 
      long lines.  You can use the ``Cell | All Output | Clear`` menu option to 
      remove all output from a notebook prior to committing it to version 
      control, if this is a concern.
 
 The notebook server can also generate a pure Python version of your notebook, 
 using the ``File | Download as`` menu option. The resulting ``.py`` file will 
 contain all the code cells from your notebook verbatim, and all Markdown cells 
 prepended with a comment marker.  The separation between code and Markdown
 cells is indicated with special comments and there is a header indicating the
 format version.  All output is removed when exporting to Python.
 
 As an example, consider a simple notebook called ``simple.ipynb`` which 
 contains one Markdown cell, with the content ``The simplest notebook.``, one 
 code input cell with the content ``print "Hello, IPython!"``, and the 
 corresponding output.
 
 The contents of the notebook document ``simple.ipynb`` is the following JSON 
 container::
 
   {
    "metadata": {
     "name": "simple"
    },
    "nbformat": 3,
    "nbformat_minor": 0,
    "worksheets": [
     {
      "cells": [
       {
        "cell_type": "markdown",
        "metadata": {},
        "source": "The simplest notebook."
       },
       {
        "cell_type": "code",
        "collapsed": false,
        "input": "print \"Hello, IPython\"",
        "language": "python",
        "metadata": {},
        "outputs": [
         {
          "output_type": "stream",
          "stream": "stdout",
          "text": "Hello, IPython\n"
         }
        ],
        "prompt_number": 1
       }
      ],
      "metadata": {}
     }
    ]
   }
 
 
 The corresponding Python script is::
 
   # -*- coding: utf-8 -*-
   # <nbformat>3.0</nbformat>
 
   # <markdowncell>
 
   # The simplest notebook.
 
   # <codecell>
 
   print "Hello, IPython"
 
 Note that indeed the output of the code cell, which is present in the JSON 
 container, has been removed in the ``.py`` script.