|
| 1 | +Overview of the matplotlib src tree |
| 2 | +=================================== |
| 3 | + |
| 4 | +This is the source directory for matplotlib, which contains the |
| 5 | +following files and directories. |
| 6 | + |
| 7 | +* doc - the matplotlib documentation. See doc/users for the user's |
| 8 | + documentation and doc/devel for the developers documentation |
| 9 | + |
| 10 | +* examples - a bunch of examples using matplotib. See |
| 11 | + examples/README.txt for information |
| 12 | + |
| 13 | +* setup.cfg.template - used to configure the matplotlib build process. |
| 14 | + Copy this file to setup.cfg if you want to override the default |
| 15 | + build behavior |
| 16 | + |
| 17 | +* matplotlibrc.template - a template file used to generate the |
| 18 | + matplotlibrc config file at build time. The matplotlibrc file will |
| 19 | + be installed in matplotlib/mpl-data/matplotlibrc |
| 20 | + |
| 21 | +* lib - the python src code. matplotlib ships several third party |
| 22 | + packages here. The subdirectory lib/matplotlib contains the python |
| 23 | + src code for matplotlib |
| 24 | + |
| 25 | +* src - the matplotlib extension code, mostly C++ |
| 26 | + |
| 27 | +* ttconv - some truetype font utilities |
| 28 | + |
| 29 | +* license - all the licenses for code included with matplotlib. |
| 30 | + matplotlib uses only BSD compatible code |
| 31 | + |
| 32 | +* unit - some unit tests |
| 33 | + |
| 34 | +* CHANGELOG - all the significant changes to matplotlib, organized by |
| 35 | + release. The top of this file will show you the most recent changes |
| 36 | + |
| 37 | +* API_CHANGES - any change that alters the API is listed here. The |
| 38 | + entries are organized by release, with most recent entries first |
| 39 | + |
| 40 | +* MIGRATION.txt - instructions on moving from the 0.91 code to the |
| 41 | + 0.98 trunk. |
| 42 | + |
| 43 | +* SEGFAULTS - some tips for how to diagnose and debug segfaults |
| 44 | + |
| 45 | +* setup.py - the matplotlib build script |
| 46 | + |
| 47 | +* setupext.py - some helper code for setup.py to build the matplotlib |
| 48 | + extensions |
| 49 | + |
| 50 | +* boilerplate.py - some code to automatically generate the pyplot |
| 51 | + wrappers |
| 52 | + |
| 53 | +* DEVNOTES - deprecated developer notes. TODO: update and move to the |
| 54 | + doc/devel framework |
| 55 | + |
| 56 | +* FILETYPES - This is a table of the output formats supported by each |
| 57 | + backend. TODO: move to doc/users |
| 58 | + |
| 59 | +* INTERACTIVE - instructions on using matplotlib interactively, eg |
| 60 | + from the python shell. TODO: update and move to doc/users. |
| 61 | + |
0 commit comments