RE: HTML: links to source are missing
Pascal Bauermeister <[email protected]>
| Newsgroups | gmane.comp.documentation.synopsis |
|---|---|
| Message-ID | <1102397238.2819.24.camel@cassis> |
On Fri, 2004-12-03 at 13:19 -0500, Stefan Seefeld wrote: > Hi Pascal, > > > From: Pascal Bauermeister [mailto:[email protected]] > > > Now when generating the HTML doc, no links to source files have been > > generated. I did: > > > > synopsis -v -f HTML -o path/to/generated/doc/html files.ast > > > > Should I pass extra arguments to the formatter ? or write a custom > > config file ? > > The generation of a cross references is not enabled by default. > As setting everything up requires quite a number of parameters, > I'd recommend to use a synopsis script instead. > Have a look into the example script in examples/Paths/doc3 in > the synopsis docs. Hi Stephan, in doc/Manual/ I found the best possible example for Python (I forgot to mention I targetted Python code), since it generates the doc for... Synopsis itself! Other than this, Synopsis gives wonderful results, and is great to document Python code. If it would be better documented (at least mentions of the examples in the doc) it would be much easier to set up. But the results are really worth the effort ! Thanks, Pascal