##// END OF EJS Templates
Include qt.console.frontend_widget in docs
Thomas Kluyver -
Show More
@@ -1,50 +1,50 b''
1 1 #!/usr/bin/env python
2 2 """Script to auto-generate our API docs.
3 3 """
4 4 # stdlib imports
5 5 import os
6 6 import sys
7 7
8 8 # local imports
9 9 sys.path.append(os.path.abspath('sphinxext'))
10 10 from apigen import ApiDocWriter
11 11
12 12 #*****************************************************************************
13 13 if __name__ == '__main__':
14 14 pjoin = os.path.join
15 15 package = 'IPython'
16 16 outdir = pjoin('source','api','generated')
17 17 docwriter = ApiDocWriter(package,rst_extension='.rst')
18 18 # You have to escape the . here because . is a special char for regexps.
19 19 # You must do make clean if you change this!
20 20 docwriter.package_skip_patterns += [r'\.external$',
21 21 # Extensions are documented elsewhere.
22 22 r'\.extensions',
23 23 r'\.config\.profile',
24 24 ]
25 25
26 26 # The inputhook* modules often cause problems on import, such as trying to
27 27 # load incompatible Qt bindings. It's easiest to leave them all out. The
28 28 # main API is in the inputhook module, which is documented.
29 29 docwriter.module_skip_patterns += [ r'\.lib\.inputhook.+',
30 30 r'\.ipdoctest',
31 31 r'\.testing\.plugin',
32 32 # This just prints a deprecation msg:
33 r'\.frontend',
33 r'\.frontend$',
34 34 ]
35 35
36 36 # We're rarely working on machines with the Azure SDK installed, so we
37 37 # skip the module that needs it in that case.
38 38 try:
39 39 import azure # analysis:ignore
40 40 except ImportError:
41 41 docwriter.module_skip_patterns.append(r'\.html\.services\.notebooks\.azurenbmanager')
42 42
43 43 # Now, generate the outputs
44 44 docwriter.write_api_docs(outdir)
45 45 # Write index with .txt extension - we can include it, but Sphinx won't try
46 46 # to compile it
47 47 docwriter.write_index(outdir, 'gen.txt',
48 48 relative_to = pjoin('source','api')
49 49 )
50 50 print ('%d files written' % len(docwriter.written_modules))
General Comments 0
You need to be logged in to leave comments. Login now