Changeset 59:8d3e5ca02fce
- Timestamp:
- 02/22/07 14:53:50 (18 months ago)
- Author:
- Tarek Ziad?? <tarek@…>
- Message:
-
last slides
- Location:
- PyCon07
- Files:
-
Legend:
- Unmodified
- Added
- Removed
-
|
r57
|
r59
|
|
| 155 | 155 | - Get the package tarball in `material` |
| 156 | 156 | - Get the text file that explains how pycommunity works, and |
| 157 | | the one that lists its main modules. |
| | 157 | the one that lists its main modules. |
| 158 | 158 | |
| 159 | 159 | Exercise 6 |
| … |
… |
|
| 301 | 301 | ::::::: |
| 302 | 302 | |
| 303 | | Take the provided PyCommunity package, and generate the documentation over |
| 304 | | the tests. Change the tutorials, recipes, etc, to see how the generated website |
| 305 | | is changed. |
| | 303 | Take the provided PyCommunity tarball (documented), and generate the |
| | 304 | documentation over the tests, by calling `pycommunity`. Change the tutorials, |
| | 305 | recipes, etc, to see how the generated website is changed. |
| 306 | 306 | |
| 307 | 307 | Prerequisites |
-
|
r53
|
r59
|
|
| 117 | 117 | - exercice: link the recipe, tutorial and glossary |
| 118 | 118 | |
| 119 | | - website autogeneration with pycommunity - 20 mn |
| | 119 | Website autogeneration with pycommunity - 20 mn |
| | 120 | =============================================== |
| 120 | 121 | |
| 121 | | - presentation: pycommunity |
| 122 | | - exercise: setting up a subversion structure |
| 123 | | - exercise: setting up a hook for website autogeneration |
| 124 | | - customize pycommunity for an existing website |
| | 122 | - presentation: pycommunity |
| | 123 | |
| | 124 | - exercises: |
| | 125 | |
| | 126 | - exercise 11: pycommunity tests |
| | 127 | - customize pycommunity for an existing website |
| 125 | 128 | |
| 126 | 129 | - conclusions, Q/A, 10 mn |
-
|
r57
|
r59
|
|
| 603 | 603 | - inline comments and doctests |
| 604 | 604 | |
| | 605 | PyCommunity |
| | 606 | =========== |
| | 607 | |
| | 608 | A tool that: |
| | 609 | |
| | 610 | - reads a bundle |
| | 611 | |
| | 612 | - extract its documentation |
| | 613 | |
| | 614 | - generates a website with it |
| | 615 | |
| | 616 | - is not released yet (soon |wink|) |
| | 617 | |
| | 618 | PyCommunity |
| | 619 | =========== |
| | 620 | |
| | 621 | - can be hooked in the subversion post-commit hook |
| | 622 | |
| | 623 | - can be configured to inject its generated page in an existing site |
| | 624 | |
| | 625 | |smile| let's try it #exercise 11 |
| | 626 | |
| | 627 | Conclusions |
| | 628 | =========== |
| | 629 | |
| | 630 | - Using `DDD` is a good way to enhance the QA |
| | 631 | |
| | 632 | - It is enjoyed by most developers |
| | 633 | |
| | 634 | - It increases both writing and programming skills |
| | 635 | |
| | 636 | The end |
| | 637 | ======= |
| | 638 | |
| | 639 | - Thank you ! |
| | 640 | |
| | 641 | - Questions ? Answers ? |
| | 642 | |
| | 643 | References |
| | 644 | ========== |
| | 645 | |
| | 646 | Useful books: |
| | 647 | |
| | 648 | - "Writing with Power" - Peter Elbow |
| | 649 | - "Agile Documentation" - Andreas RÃŒping |
| | 650 | |
| | 651 | Useful websites: |
| | 652 | |
| | 653 | - http://emenciacommerce.com/en: Emencia Commerce Suite - My company software |
| | 654 | - http://tarekziade.wordpress.com : My blog |
| | 655 | |
| | 656 | Incoming Events |
| | 657 | =============== |
| | 658 | |
| | 659 | You all go to Rupy in Poznan, Polan, 14/15 April |wink| |
| 605 | 660 | |
| 606 | 661 | .. |wink| image:: media/wink.png |