| 1 | This describes how to build the documentation found in the |
| 2 | org.eclipse.tracecompass.*.doc.* plugins. |
| 3 | |
| 4 | |
| 5 | Your Eclipse environment first needs to have the "Mylyn Wikitext" plugin |
| 6 | installed. It can be found in the default Eclipse repository, under |
| 7 | "Collaboration". |
| 8 | |
| 9 | Once that is installed, you should be able to use the manual Eclipse builder to |
| 10 | generate the doc : select the and individual doc plugin and choose, in the |
| 11 | top-menu, "Project -> Build Project". |
| 12 | |
| 13 | It uses the build.xml Ant script, but it's recommended to run it from within |
| 14 | Eclipse, since the builder will pass some environment variables that the script |
| 15 | needs. |
| 16 | |
| 17 | You might get a warning from build.properties because of a missing file. This |
| 18 | file gets generated with the rest of the doc, so once you have run these steps |
| 19 | (and refreshed the project if needed), the warning should disappear. |