Generate API reST files. Parameters ---------- outdir : string Directory name in which to store files We create automatic filenames for each module Returns ------- None Notes ----- Sets self.written_mo
(self, outdir)
| 408 | self.written_modules = written_modules |
| 409 | |
| 410 | def write_api_docs(self, outdir): |
| 411 | """Generate API reST files. |
| 412 | |
| 413 | Parameters |
| 414 | ---------- |
| 415 | outdir : string |
| 416 | Directory name in which to store files |
| 417 | We create automatic filenames for each module |
| 418 | |
| 419 | Returns |
| 420 | ------- |
| 421 | None |
| 422 | |
| 423 | Notes |
| 424 | ----- |
| 425 | Sets self.written_modules to list of written modules |
| 426 | """ |
| 427 | if not os.path.exists(outdir): |
| 428 | os.mkdir(outdir) |
| 429 | # compose list of modules |
| 430 | modules = self.discover_modules() |
| 431 | self.write_modules_api(modules,outdir) |
| 432 | |
| 433 | def write_index(self, outdir, path='gen.rst', relative_to=None): |
| 434 | """Make a reST API index file from written files |
no test coverage detected