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

javascript domain: bug on windows build #125

Closed
fredbi opened this issue Nov 6, 2017 · 2 comments
Closed

javascript domain: bug on windows build #125

fredbi opened this issue Nov 6, 2017 · 2 comments
Labels

Comments

@fredbi
Copy link
Contributor

fredbi commented Nov 6, 2017

In mappers/javascript.py

On windows, the jsdoc command is actually named jsdoc.cmd and is not recognized by subprocess().

Proposed:

subcmd = 'jsdoc'
if os.name == 'nt':
    subcmd='.'.join([subcmd,'cmd'])
parsed_data = json.loads(subprocess.check_output([subcmd, '-X', path])) 

Could be nice to support an optional path for these commands in conf.py

@agjohnson agjohnson added the Bug label Nov 12, 2017
@agjohnson
Copy link
Contributor

Yeah, perhaps a config option is the most correct fix here? I'm not familiar with windows development with node, but it seems like this shouldn't be magic that we need to use. Rather, is there something we're not doing with the subprocess call that would imply a .exe/.cmd prefix?

@fredbi
Copy link
Contributor Author

fredbi commented Nov 12, 2017

I have been checking the subprocess doc and nothing looks like that. Safest to check the os in our code I guess.

Optionnally configuring paths for required tools would be a nice bonus.

fredbi added a commit to fredbi/sphinx-autoapi that referenced this issue Nov 12, 2017
Issue readthedocs#125.
jsdoc on windows is deployed as jsdoc.cmd
fredbi added a commit to fredbi/sphinx-autoapi that referenced this issue Nov 13, 2017
lint + import os
AWhetter pushed a commit that referenced this issue Jul 12, 2018
Issue #125.
jsdoc on windows is deployed as jsdoc.cmd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants