|
Revision 262
(checked in by fenix, 3 years ago)
|
changed createDocumentationDirectoryView method and fix bugs in prefs_portal_documentation.cptcd '/home/fenix/work/qPloneEpydoc'
|
| Line | |
|---|
| 1 |
Quintagroup Plone Documentation generator |
|---|
| 2 |
|
|---|
| 3 |
This product lets you generate API documentation for any one product |
|---|
| 4 |
that is on your Plone site. qPlonEpydoc is build on Epydoc |
|---|
| 5 |
and using it to generate API documentation based on docstrings. |
|---|
| 6 |
|
|---|
| 7 |
(c) "Quintagroup":http://quintagroup.com/ , 2006. |
|---|
| 8 |
|
|---|
| 9 |
support@quintagroup.com * quintessence of modern business |
|---|
| 10 |
|
|---|
| 11 |
Requirements |
|---|
| 12 |
|
|---|
| 13 |
* Archetypes-1.3 |
|---|
| 14 |
* epydoc-2.1 |
|---|
| 15 |
|
|---|
| 16 |
Usage |
|---|
| 17 |
|
|---|
| 18 |
1. Install with Quick Installer. |
|---|
| 19 |
|
|---|
| 20 |
2. Go to Plone Setup -> PloneEpydoc |
|---|
| 21 |
|
|---|
| 22 |
3. Choose needed product in Products field and click on "generate" button. |
|---|
| 23 |
|
|---|
| 24 |
4. Then you will see generated documentation link |
|---|
| 25 |
and all you need to do to view documentation is to click on that link. |
|---|
| 26 |
|
|---|
| 27 |
Author |
|---|
| 28 |
|
|---|
| 29 |
* Taras Melnychuk |
|---|
