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

Trouble using yuidoc.json #160

Open
ghost opened this issue May 22, 2013 · 6 comments
Open

Trouble using yuidoc.json #160

ghost opened this issue May 22, 2013 · 6 comments

Comments

@ghost
Copy link

ghost commented May 22, 2013

Hi,

This might not be an issue but I am not able to figure this out. All the settings seem to be correct.

I have just started using yuidoc. However, I am having a slight issue. I have the outdir option to point to my custom directory in yuidoc.json file. But on running yuidoc . on my source tree, I cannot see the files under the custom directory. The default "out" folder is generated, just seems as thought the outdir option is ignored. Could you help me out here?

YUIDoc version: 0.3.44
Node version: 0.8.22
YUI version: 3.9.1

Thanks,

@ghost
Copy link
Author

ghost commented May 22, 2013

Figured this out. Had to provide the -c yuidoc.json option to the yuidoc command too.

@ghost ghost closed this as completed May 22, 2013
@ghost ghost reopened this May 22, 2013
@ghost
Copy link
Author

ghost commented May 22, 2013

Even though this worked it would be good to know why it did not work without adding the -c switch.

@slolife
Copy link

slolife commented Jun 21, 2013

Putting the yuidoc.json file in the search path doesn't seem to work. Ran it with the --server option and the server debug output says that it found my yuidoc.json file and was processing it, the values in the name/version/logo were not used. Then I used the --config option and it works.

@polyglotinc
Copy link

I am having problems even specifying the -c option. [Using YUIDoc@0.3.47 using YUI@3.9.1 with NodeJS@0.10.24]
Without the -c option, it says...
info: (yuidoc): Loading yuidoc.json data from: Z:\Workspaces\Eclipse 3.6\yada_yada\yuidoc.json
but it doesn't actually change anything.
With the -c option it doesn't mention the json file, nor changes anything either.
Others are having this problem now too: http://stackoverflow.com/questions/20975379/yuidoc-parses-but-no-output-and-no-errors

BTW, my json is trivial...
{
"name": "Graevy",
"description": "MVC/OOP framework written in Javascript",
"version": "3.0.0",
"url": "http://www.polyglotinc.com/Graevy/",
"logo": "http://www.polyglotinc.com/Gravy/Gravy/logo.jpg"
}

@lexander
Copy link
Contributor

I am able to reproduce the problem that @polyglotinc described using YUIDocJS@0.3.47 and nodejs@0.10.12

By adding an 'options' entry with an 'outdir' directory to the JSON that @polyglotinc used I was able to get the correct output (e.g. had the logo URL pointing to http://www.polyglotinc.com/Gravy/Gravy/logo.jpg and the correct version number.

NOTE - the output directory is actually the same as the default output directory. Using an empty 'options' object did not trigger YUIDoc to apply the other settings properly.

{
    "name": "Graevy",
    "description": "MVC/OOP framework written in Javascript",
    "version": "3.0.0",
    "url": "http://www.polyglotinc.com/Graevy/",
    "logo": "http://www.polyglotinc.com/Gravy/Gravy/logo.jpg",
    "options": {
        "outdir": "./out"
    }
}

@martin-brennan-fs
Copy link

Had the same problem, did what lexander said and added an options block with the default output directory and it worked fine.

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

4 participants