Show More
@@ -0,0 +1,1 b'' | |||||
|
1 | * The module ``IPython.core.fakemodule`` has been removed. |
@@ -1,66 +1,66 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | """Script to auto-generate our API docs. |
|
2 | """Script to auto-generate our API docs. | |
3 | """ |
|
3 | """ | |
4 | # stdlib imports |
|
4 | # stdlib imports | |
5 | import os |
|
5 | import os | |
6 | import sys |
|
6 | import sys | |
7 |
|
7 | |||
8 | # local imports |
|
8 | # local imports | |
9 | sys.path.append(os.path.abspath('sphinxext')) |
|
9 | sys.path.append(os.path.abspath('sphinxext')) | |
10 | from apigen import ApiDocWriter |
|
10 | from apigen import ApiDocWriter | |
11 |
|
11 | |||
12 | #***************************************************************************** |
|
12 | #***************************************************************************** | |
13 | if __name__ == '__main__': |
|
13 | if __name__ == '__main__': | |
14 | pjoin = os.path.join |
|
14 | pjoin = os.path.join | |
15 | package = 'IPython' |
|
15 | package = 'IPython' | |
16 | outdir = pjoin('source','api','generated') |
|
16 | outdir = pjoin('source','api','generated') | |
17 | docwriter = ApiDocWriter(package,rst_extension='.rst') |
|
17 | docwriter = ApiDocWriter(package,rst_extension='.rst') | |
18 | # You have to escape the . here because . is a special char for regexps. |
|
18 | # You have to escape the . here because . is a special char for regexps. | |
19 | # You must do make clean if you change this! |
|
19 | # You must do make clean if you change this! | |
20 | docwriter.package_skip_patterns += [r'\.fixes$', |
|
20 | docwriter.package_skip_patterns += [r'\.fixes$', | |
21 | r'\.external$', |
|
21 | r'\.external$', | |
22 | r'\.extensions', |
|
22 | r'\.extensions', | |
23 | r'\.kernel\.config', |
|
23 | r'\.kernel\.config', | |
24 | r'\.attic', |
|
24 | r'\.attic', | |
25 | r'\.quarantine', |
|
25 | r'\.quarantine', | |
26 | r'\.deathrow', |
|
26 | r'\.deathrow', | |
27 | r'\.config\.default', |
|
27 | r'\.config\.default', | |
28 | r'\.config\.profile', |
|
28 | r'\.config\.profile', | |
29 | r'\.frontend', |
|
29 | r'\.frontend', | |
30 | r'\.gui', |
|
30 | r'\.gui', | |
31 | r'\.kernel', |
|
31 | r'\.kernel', | |
32 | # For now, the zmq code has |
|
32 | # For now, the zmq code has | |
33 | # unconditional top-level code so it's |
|
33 | # unconditional top-level code so it's | |
34 | # not import safe. This needs fixing |
|
34 | # not import safe. This needs fixing | |
35 | r'\.zmq', |
|
35 | r'\.zmq', | |
36 | ] |
|
36 | ] | |
37 |
|
37 | |||
38 |
docwriter.module_skip_patterns += [ |
|
38 | docwriter.module_skip_patterns += [ | |
39 | r'\.testing\.iptest', |
|
39 | r'\.testing\.iptest', | |
40 | # Keeping these disabled is OK |
|
40 | # Keeping these disabled is OK | |
41 | r'\.parallel\.controller\.mongodb', |
|
41 | r'\.parallel\.controller\.mongodb', | |
42 | r'\.lib\.inputhookwx', |
|
42 | r'\.lib\.inputhookwx', | |
43 | r'\.lib\.inputhookgtk', |
|
43 | r'\.lib\.inputhookgtk', | |
44 | r'\.cocoa', |
|
44 | r'\.cocoa', | |
45 | r'\.ipdoctest', |
|
45 | r'\.ipdoctest', | |
46 | r'\.Gnuplot', |
|
46 | r'\.Gnuplot', | |
47 | r'\.frontend\.process\.winprocess', |
|
47 | r'\.frontend\.process\.winprocess', | |
48 | r'\.frontend', |
|
48 | r'\.frontend', | |
49 | r'\.Shell', |
|
49 | r'\.Shell', | |
50 | ] |
|
50 | ] | |
51 |
|
51 | |||
52 | # If we don't have pexpect, we can't load irunner, so skip any code that |
|
52 | # If we don't have pexpect, we can't load irunner, so skip any code that | |
53 | # depends on it |
|
53 | # depends on it | |
54 | try: |
|
54 | try: | |
55 | import pexpect |
|
55 | import pexpect | |
56 | except ImportError: |
|
56 | except ImportError: | |
57 | docwriter.module_skip_patterns += [r'\.lib\.irunner', |
|
57 | docwriter.module_skip_patterns += [r'\.lib\.irunner', | |
58 | r'\.testing\.mkdoctests'] |
|
58 | r'\.testing\.mkdoctests'] | |
59 | # Now, generate the outputs |
|
59 | # Now, generate the outputs | |
60 | docwriter.write_api_docs(outdir) |
|
60 | docwriter.write_api_docs(outdir) | |
61 | # Write index with .txt extension - we can include it, but Sphinx won't try |
|
61 | # Write index with .txt extension - we can include it, but Sphinx won't try | |
62 | # to compile it |
|
62 | # to compile it | |
63 | docwriter.write_index(outdir, 'gen.txt', |
|
63 | docwriter.write_index(outdir, 'gen.txt', | |
64 | relative_to = pjoin('source','api') |
|
64 | relative_to = pjoin('source','api') | |
65 | ) |
|
65 | ) | |
66 | print ('%d files written' % len(docwriter.written_modules)) |
|
66 | print ('%d files written' % len(docwriter.written_modules)) |
General Comments 0
You need to be logged in to leave comments.
Login now