##// END OF EJS Templates
added examples and info for nbconvert
Paul Ivanov -
Show More
@@ -24,7 +24,7 b' import os'
24
24
25 #From IPython
25 #From IPython
26 from IPython.config.application import Application
26 from IPython.config.application import Application
27 from IPython.utils.traitlets import Bool
27 from IPython.utils.traitlets import Bool, Unicode
28
28
29 from .exporters.export import export_by_name
29 from .exporters.export import export_by_name
30 from .exporters.exporter import Exporter
30 from .exporters.exporter import Exporter
@@ -39,18 +39,27 b' from .utils.config import GlobalConfigurable'
39 KEYS_PROMPT_HEAD = "====================== Keys in Resources =================================="
39 KEYS_PROMPT_HEAD = "====================== Keys in Resources =================================="
40 KEYS_PROMPT_BODY = """
40 KEYS_PROMPT_BODY = """
41 ===========================================================================
41 ===========================================================================
42 You are responsible for writting these files into the appropriate
42 You are responsible for writing these files into the appropriate
43 directorie(s) if need be. If you do not want to see this message, enable
43 directory(ies) if need be. If you do not want to see this message, enable
44 the 'write' (boolean) flag of the converter.
44 the 'write' (boolean) flag of the converter.
45 ===========================================================================
45 ===========================================================================
46 """
46 """
47
47
48 _examples = """
49 ipython nbconvert rst Untitled0.ipynb # convert ipynb to ReStructured Text
50 ipython nbconvert latex Untitled0.ipynb # convert ipynb to LaTeX
51 ipython nbconvert reveal Untitled0.ipynb # convert to Reveal (HTML/JS) slideshow
52 """
53
48 #-----------------------------------------------------------------------------
54 #-----------------------------------------------------------------------------
49 #Classes and functions
55 #Classes and functions
50 #-----------------------------------------------------------------------------
56 #-----------------------------------------------------------------------------
51
57
52 class NbConvertApp(Application):
58 class NbConvertApp(Application):
53 """Application used to convert to and from notebook file type (*.ipynb)"""
59 """Application used to convert to and from notebook file type (*.ipynb)"""
60 description = Unicode(__doc__)
61
62 examples = _examples
54
63
55 stdout = Bool(
64 stdout = Bool(
56 False, config=True,
65 False, config=True,
General Comments 0
You need to be logged in to leave comments. Login now