[TIMOB-1695] docgen.py hardcodes output path to ~/work/appcelerator_network/new/public/devcenter/application...
GitHub Issue | n/a |
---|---|
Type | Bug |
Priority | Trivial |
Status | Closed |
Resolution | Cannot Reproduce |
Resolution Date | 2012-07-25T18:00:27.000+0000 |
Affected Version/s | n/a |
Fix Version/s | n/a |
Components | iOS |
Labels | apidoc, docgen.py |
Reporter | Brion Vibber |
Assignee | Nolan Wright |
Created | 2011-04-15T02:59:47.000+0000 |
Updated | 2012-07-25T18:00:27.000+0000 |
Description
While attempting to confirm my formatting in a patch for API docs, I ran the output generation script docgen.py; to my surprise, this has a hardcoded output path of ~/work/appcelerator_network/new/public/devcenter/application/apidoc/mobile/1.4, which is not mentioned while running the script and can only be changed by modifying the script's source code:
if __name__ == "__main__":
main(sys.argv)
main([sys.argv[0],'json','output=~/tmp/doc'])
main([sys.argv[0],'devhtml','output=~/work/appcelerator_network/new/public/devcenter/application/apidoc/mobile/1.0.0'])
main([sys.argv[0],'devhtml','version=1.4','output=~/work/appcelerator_network/new/public/devcenter/application/apidoc/mobile/1.4'])
main([sys.argv[0],'devhtml','colorize','css=page.css','output=~/work/titanium_mobile/demos/KitchenSink_iPad/Resources/apidoc'])
The output format and directory should be settable as command-line options, and should either have a clearer default or require that an explicit value be set when running.
Assigning to our support contact. (Nolan, is there someone in charge of API documentation that we should assign these to more directly? Thanks!)
Cannot reproduce with 2.2.0.014b86f. Tested via: