You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by kant2002 <gi...@git.apache.org> on 2014/09/13 18:10:32 UTC
[GitHub] cordova-docs pull request: CB-6751 Added joDoc dependency
GitHub user kant2002 opened a pull request:
https://github.com/apache/cordova-docs/pull/236
CB-6751 Added joDoc dependency
I try using NodeJS joDoc, but have following findings:
1. It fail to work on Windows out of the box. Because it does not know how to create nested directory structure. Has to put fix for that. Fix available at https://github.com/kant2002/jodoc-js
2. All pre- and post-processing logic should be reimplemented in JS.
3. Should be found alternative for Nocogiri in Node.JS community. Seems that this link http://stackoverflow.com/questions/7977945/html-parser-on-nodejs has good options.
From first sight https://github.com/cheeriojs/cheerio looks best choice which allows finish implementation faster.
jsdom looks good to, but looks like it is pain to setup on Windows. Since I develop on Windows, my preference is not to use it.
Also joDocs looks not maintained anymore, so we probable have to put some effort to keep it running as needed for the Cordova.
Will push updates about this issue to this branch/pull request, as more progress will be done
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/kant2002/cordova-docs CB-6751
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-docs/pull/236.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #236
----
commit 809c23b91772523570f6d8f5ca15bb41d6294ea1
Author: Andrey Kurdyumov <ka...@gmail.com>
Date: 2014-09-13T16:05:08Z
Added joDoc dependency
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] cordova-docs pull request: CB-6751 Added joDoc dependency
Posted by kant2002 <gi...@git.apache.org>.
Github user kant2002 commented on the pull request:
https://github.com/apache/cordova-docs/pull/236#issuecomment-55521334
Add following file processors:
1. version menu builder
2. update indexes processor
3. update keyword index processor
Added ability to specify logging
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] cordova-docs pull request: CB-6751 Added joDoc dependency
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-docs/pull/236
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-6751 Added joDoc dependency
Posted by kant2002 <gi...@git.apache.org>.
Github user kant2002 commented on the pull request:
https://github.com/apache/cordova-docs/pull/236#issuecomment-56008552
Added folowing:
1. TOC builder
2. YAML stripper
2. Tests for existing processors and new one added
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] cordova-docs pull request: CB-6751 Added joDoc dependency
Posted by shazron <gi...@git.apache.org>.
Github user shazron commented on the pull request:
https://github.com/apache/cordova-docs/pull/236#issuecomment-61442878
Thanks @kant2002 - but I'm running into some problems with a fresh copy of your branch. Here's what I did:
```
$ git clone https://github.com/kant2002/cordova-docs.git
$ cd cordova-docs
$ git checkout CB-6751
$ npm install
$ bin/genjs
[...]
=> Generating the Cordova Documentation for 1.5.0-en...
fs.js:432
return binding.open(pathModule._makeLong(path), stringToFlags(flags), mode);
^
Error: ENOENT, no such file or directory '/Users/shazron/Desktop/cordova-docs/tmp/docs/cordova/accelerometer/accelerometer.getCurrentAcceleration.md'
at Object.fs.openSync (fs.js:432:18)
at Object.fs.readFileSync (fs.js:289:15)
at FileMerger.run (/Users/shazron/Desktop/cordova-docs/lib/cordova/pre/filemerger.js:74:44)
at /Users/shazron/Desktop/cordova-docs/lib/docs_generator.js:147:32
at /Users/shazron/Desktop/cordova-docs/lib/docs_generator.js:39:17
at Array.forEach (native)
at processEachFile (/Users/shazron/Desktop/cordova-docs/lib/docs_generator.js:30:26)
at /Users/shazron/Desktop/cordova-docs/lib/docs_generator.js:44:17
at Array.forEach (native)
at processEachFile (/Users/shazron/Desktop/cordova-docs/lib/docs_generator.js:30:26)
```
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-6751 Added joDoc dependency
Posted by kant2002 <gi...@git.apache.org>.
Github user kant2002 commented on the pull request:
https://github.com/apache/cordova-docs/pull/236#issuecomment-55519035
Added basic implementation for the generation process. Left to reimplement pre- and post-processing logic.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---