##// END OF EJS Templates
Document IPython.display API correctly
Thomas Kluyver -
Show More
@@ -28,6 +28,12 b' from IPython.utils.py3compat import (string_types, cast_bytes_py2, cast_unicode,'
28 from IPython.testing.skipdoctest import skip_doctest
28 from IPython.testing.skipdoctest import skip_doctest
29 from .displaypub import publish_display_data
29 from .displaypub import publish_display_data
30
30
31 __all__ = ['display', 'display_pretty', 'display_html', 'display_markdown',
32 'display_svg', 'display_png', 'display_jpeg', 'display_latex', 'display_json',
33 'display_javascript', 'display_pdf', 'DisplayObject', 'TextDisplayObject',
34 'Pretty', 'HTML', 'Markdown', 'Math', 'Latex', 'SVG', 'JSON', 'Javascript',
35 'clear_output', 'set_matplotlib_formats', 'set_matplotlib_close']
36
31 #-----------------------------------------------------------------------------
37 #-----------------------------------------------------------------------------
32 # utility functions
38 # utility functions
33 #-----------------------------------------------------------------------------
39 #-----------------------------------------------------------------------------
@@ -7,6 +7,9 b' from os import walk, sep'
7
7
8 from IPython.core.display import DisplayObject
8 from IPython.core.display import DisplayObject
9
9
10 __all__ = ['Audio', 'IFrame', 'YouTubeVideo', 'VimeoVideo', 'ScribdDocument',
11 'FileLink', 'FileLinks']
12
10
13
11 class Audio(DisplayObject):
14 class Audio(DisplayObject):
12 """Create an audio object.
15 """Create an audio object.
@@ -38,6 +38,9 b" if __name__ == '__main__':"
38 # These are exposed by nbformat.current
38 # These are exposed by nbformat.current
39 r'\.nbformat\.convert',
39 r'\.nbformat\.convert',
40 r'\.nbformat\.validator',
40 r'\.nbformat\.validator',
41 # These are exposed in display
42 r'\.core\.display',
43 r'\.lib\.display',
41 ]
44 ]
42
45
43 # These modules import functions and classes from other places to expose
46 # These modules import functions and classes from other places to expose
@@ -46,6 +49,7 b" if __name__ == '__main__':"
46 # above.
49 # above.
47 docwriter.names_from__all__.update({
50 docwriter.names_from__all__.update({
48 'IPython.nbformat.current',
51 'IPython.nbformat.current',
52 'IPython.display',
49 })
53 })
50
54
51 # Now, generate the outputs
55 # Now, generate the outputs
General Comments 0
You need to be logged in to leave comments. Login now