[TIMOB-3384] apidoc: Change markdown dependency to markdown2
GitHub Issue | n/a |
---|---|
Type | Bug |
Priority | Low |
Status | Closed |
Resolution | Fixed |
Resolution Date | 2011-05-24T14:41:01.000+0000 |
Affected Version/s | n/a |
Fix Version/s | Release 1.7.0, Sprint 2011-12 |
Components | iOS |
Labels | apidoc, release-1.7.0 |
Reporter | Bill Dawson |
Assignee | Bill Dawson |
Created | 2011-04-15T03:43:36.000+0000 |
Updated | 2011-05-24T14:41:01.000+0000 |
Description
Since api.jsca needs to be generated during builds, we've made the build machines become dependent on markdown. We already ship with markdown2 in the SDK, however (support/module/support/markdown2.py). We should reconcile these so we don't ship with two markdown processors.
Hmm, we need support for fenced code blocks (the "three tilde" code blocks we do all over the place in "titanium markdown"). Python-Markdown (
import markdown
) supports this via a built-in extension which we use. python-markdown2 (import markdown2
) has no such support and I really don't want to write it. :)For now, to get rid of the external markdown dependency in docgen.py (so we don't need to easy_install it on build machines), I'm packing in markdown, since it's BSD License. Yup, that means we have two markdown processors packaged in our source tree. :) Maybe Marshall is not married to markdown2?
(from [cf9148d2287e8ef92bf0944984370664aa7a16df]) Remove scons package.py markdown module warning, since it's no longer relevant. [#3384] https://github.com/appcelerator/titanium_mobile/commit/cf9148d2287e8ef92bf0944984370664aa7a16df"> https://github.com/appcelerator/titanium_mobile/commit/cf9148d2287e...
Main commit:
https://github.com/appcelerator/titanium_mobile/commit/a223ce421f4931c9a1e109237483983df5178d1b"> https://github.com/appcelerator/titanium_mobile/commit/a223ce421f49...
For thorough QE testing:
Make sure you can build the SDK without any warnings on both OS X and Windows.
When you unzip the built SDK, make sure the file api.jsca is in the root, and is not 0-length file (it's about 3.9MB).
Make sure (on Windows and OS X) that you can go to the
apidoc/
source folder and successfully runpython docgen.py
. (By successfully I mean it completes without error.BTW, when you test this, note that you do need the python Mako and Pygments modules to do that third step (the python docgen.py step). I wanted to mention that, in case you've never run python docgen.py before.
built Rc1 on win7 and os10.6.7 with no warnings. stil need to verify other steps
all steps confirmed on osx, reinstalling/setting up windows
Tested with win7 generate apidoc and scons build with no errors 1.7.0.eee3c23