{ "id": "64016", "key": "TIMOB-3384", "fields": { "issuetype": { "id": "1", "description": "A problem which impairs or prevents the functions of the product.", "name": "Bug", "subtask": false }, "project": { "id": "10153", "key": "TIMOB", "name": "Titanium SDK/CLI", "projectCategory": { "id": "10100", "description": "Titanium and related SDKs used in application development", "name": "Client" } }, "fixVersions": [ { "id": "11244", "name": "Release 1.7.0", "archived": true, "released": true, "releaseDate": "2011-06-13" }, { "id": "11247", "name": "Sprint 2011-12", "archived": true, "released": true, "releaseDate": "2011-03-28" } ], "resolution": { "id": "1", "description": "A fix for this issue is checked into the tree and tested.", "name": "Fixed" }, "resolutiondate": "2011-05-24T14:41:01.000+0000", "created": "2011-04-15T03:43:36.000+0000", "priority": { "name": "Low", "id": "4" }, "labels": [ "apidoc", "release-1.7.0" ], "versions": [], "issuelinks": [], "assignee": { "name": "billdawson", "key": "billdawson", "displayName": "Bill Dawson", "active": true, "timeZone": "Europe/Berlin" }, "updated": "2011-05-24T14:41:01.000+0000", "status": { "description": "The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.", "name": "Closed", "id": "6", "statusCategory": { "id": 3, "key": "done", "colorName": "green", "name": "Done" } }, "components": [ { "id": "10206", "name": "iOS", "description": "iOS Platform" } ], "description": "{html}
Since api.jsca needs to be generated during builds, we've made\nthe build machines become dependent on markdown. We already ship\nwith markdown2 in the SDK, however\n(support/module/support/markdown2.py). We should reconcile these so\nwe don't ship with two markdown processors.
Hmm, we need support for fenced code blocks (the \"three tilde\"\ncode blocks we do all over the place in \"titanium markdown\").\nPython-Markdown (import markdown
) supports this via a\nbuilt-in extension which we use. python-markdown2 (import\nmarkdown2
) has no such support and I really don't want to\nwrite it. :)
For now, to get rid of the external markdown dependency in\ndocgen.py (so we don't need to easy_install it on build machines),\nI'm packing in markdown, since it's BSD License. Yup, that means we\nhave two markdown processors packaged in our source tree. :) Maybe\nMarshall is not married to markdown2?
(from [cf9148d2287e8ef92bf0944984370664aa7a16df])\nRemove scons package.py markdown module warning, since it's no\nlonger relevant. [#3384] \nhttps://github.com/appcelerator/titanium_mobile/commit/cf9148d2287e...
For thorough QE testing:
\nMake sure you can build the SDK without any warnings on both OS\nX and Windows.
\nWhen you unzip the built SDK, make sure the file api.jsca is in\nthe root, and is not 0-length file (it's about 3.9MB).
\nMake sure (on Windows and OS X) that you can go to the\napidoc/
source folder and successfully run\npython docgen.py
. (By successfully I mean it completes\nwithout error.
BTW, when you test this, note that you do need the python Mako\nand Pygments modules to do that third step (the python docgen.py\nstep). I wanted to mention that, in case you've never run python\ndocgen.py before.