Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

generating docs on Windows (MSYSGIT) does not work #6

Closed
dhodgin opened this issue Apr 2, 2013 · 8 comments
Closed

generating docs on Windows (MSYSGIT) does not work #6

dhodgin opened this issue Apr 2, 2013 · 8 comments

Comments

@dhodgin
Copy link

dhodgin commented Apr 2, 2013

when i run the command
doxx --source lib --target docs

from my folder which has a lib folder with about 10 .js files in it some of which have jsdocs style comments all i get at the output is an index.html file in /docs

when we run this on mac it works fine on our repo and generates a html file for each js file in the lib folder

also on windows when i run
doxx --source . --target ../docs
while in the lib folder i get an error thrown. was thinking i could try generating the docs while in the folder

@FGRibreau
Copy link
Member

Did you find a solution?

@dhodgin
Copy link
Author

dhodgin commented Apr 16, 2013

no not yet. Our solution is to generate the docs on a mac and just commit them to the repo and update them periodically for now. hacky but better than nothing.

@FGRibreau
Copy link
Member

Indeed :)

@itamarro
Copy link

Hay guys, ran into this as well. The reason is that 'findit' does not work well on Windows. It seems that 'walkdir' is pretty much a drop-in replacement that works well and has been adopted by dox-foundation as well.

Please see here: mattmcmanus/dox-foundation#23

(If you want to dig deeper: https://github.com/substack/node-findit/issues/5 )

Would it be possible to make the switch to walkdir here as well?

@FGRibreau
Copy link
Member

Hi @itamarro just send me a pull-request with the modification and I'll happily merge it!

@itamarro
Copy link

Excellent! #16

@FGRibreau
Copy link
Member

Done :)

@itamarro
Copy link

Thanks! @dhodgin, if you could certify it works for you too it'd be great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants