[TIMOB-6765] APIDoc: docgen.py with --colorize flag is colorizing inline code spans
GitHub Issue | n/a |
---|---|
Type | Bug |
Priority | Low |
Status | Closed |
Resolution | Won't Do |
Resolution Date | 2016-08-22T20:35:01.000+0000 |
Affected Version/s | Release 1.8.0 |
Fix Version/s | n/a |
Components | n/a |
Labels | n/a |
Reporter | Arthur Evans |
Assignee | Ingo Muschenetz |
Created | 2011-12-19T15:36:06.000+0000 |
Updated | 2018-09-21T17:23:41.000+0000 |
Description
When invoked with the --colorize flag, docgen is invoking the colorizer on anything with a
tag, not just code samples.
If doc includes phrases like: "the Titanium.UI
module" the "Titanium.UI" portion is treated as a code sample, broken out into a block and colorized. This is not correct.
The current web app is doing some colorizing, but if you compare the 1.7.5 docs with the 1.8.0.1RC1 docs (created without --colorize) you can see the results are not the same:
http://developer.appcelerator.com/apidoc/mobile/1.8.0.1.RC2/Titanium.UI.Window-object
http://developer.appcelerator.com/apidoc/mobile/latest/Titanium.UI.Window-object
As far as I can tell, we don't use docgen.py anymore. Most of our doc pub scripts have been migrated to Node. If we still want to add color to the
tags, it is possible.
Closing ticket with reference to the above comment.