search

cupid-ide / cupid

Cupid IDE and Code Generation Tool for Earth System Models
Other
5 stars 6 forks source link

Parse Protex for automated reference documentation & content completion #10

Open rsdunlapiv opened 10 years ago

rsdunlapiv commented 10 years ago

The NUOPC view outline includes help from the reference manual when the user hovers over a node. The documentation is currently copied over manually from the ref manual. Automating this somehow (i.e., pointing to the original source material) would reduce maintenance.

rsdunlapiv commented 9 years ago

The docs are currently stored in a big XML file, editing manually, mostly copied from the reference manual. They can get out of sync easily and the manual editing is time consuming.

The documentation viewer in Cupid is actually a mini web browser, so we could point to the existing reference manual. However it needs to be written in such a way that it makes when viewed from the tool.

rsdunlapiv commented 8 years ago

Changed title of ticket to reflect that we can parse the in-code Protex to automatically bring in API information from the reference manual.

The basic parsing works now. Need to work on displaying the LaTeX correctly.