Show More
@@ -51,7 +51,10 b' def DocDecorator(f):' | |||||
51 | exporter_instance : Exporter |
|
51 | exporter_instance : Exporter | |
52 | Instance of the Exporter class used to export the document. Useful |
|
52 | Instance of the Exporter class used to export the document. Useful | |
53 | to caller because it provides a 'file_extension' property which |
|
53 | to caller because it provides a 'file_extension' property which | |
54 |
specifies what extension the output should be saved as. |
|
54 | specifies what extension the output should be saved as. | |
|
55 | ||||
|
56 | WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT | |||
|
57 | """ | |||
55 |
|
58 | |||
56 | @wraps(f) |
|
59 | @wraps(f) | |
57 | def decorator(*args, **kwargs): |
|
60 | def decorator(*args, **kwargs): | |
@@ -196,7 +199,10 b' def export_by_name(format_name, nb, **kw):' | |||||
196 |
|
199 | |||
197 |
|
200 | |||
198 | def get_export_names(): |
|
201 | def get_export_names(): | |
199 |
"Return a list of the currently supported export targets |
|
202 | """Return a list of the currently supported export targets | |
|
203 | ||||
|
204 | WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT""" | |||
|
205 | ||||
200 | # grab everything after 'export_' |
|
206 | # grab everything after 'export_' | |
201 | l = [x[len('export_'):] for x in __all__ if x.startswith('export_')] |
|
207 | l = [x[len('export_'):] for x in __all__ if x.startswith('export_')] | |
202 |
|
208 |
@@ -89,7 +89,9 b' class NbConvertApp(BaseIPythonApplication):' | |||||
89 |
|
89 | |||
90 | description = Unicode( |
|
90 | description = Unicode( | |
91 | u"""This application is used to convert notebook files (*.ipynb) |
|
91 | u"""This application is used to convert notebook files (*.ipynb) | |
92 |
to various other formats. |
|
92 | to various other formats. | |
|
93 | ||||
|
94 | WARNING: THE COMMANDLINE INTERFACE MAY CHANGE IN FUTURE RELEASES.""") | |||
93 |
|
95 | |||
94 | examples = Unicode(u""" |
|
96 | examples = Unicode(u""" | |
95 | The simplest way to use nbconvert is |
|
97 | The simplest way to use nbconvert is |
General Comments 0
You need to be logged in to leave comments.
Login now