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

project-name & project-version not being set #691

Open
thedark1337 opened this issue Mar 10, 2017 · 3 comments
Open

project-name & project-version not being set #691

thedark1337 opened this issue Mar 10, 2017 · 3 comments

Comments

@thedark1337
Copy link

I'm using the latest version of documentation.js (v4.0.0-beta.18) , node.js version 7.7.1, npm version 4.3.0 on windows 10.

The command to generate docs is: documentation build lib/*.js -c documentation.yml -f html -o docs

I am working on a project generating documentation and it seems that the version doesn't get picked up automatically nor the name.

A snippet of the package.json

{  "name": "myProject",
  "description": "description for myProject",
  "version": "5.0.0-beta.3"
}

I can however set the project version via --project-version and documentation.yml with:

 project-version: 
  - 5.0.0-beta.3 

project-name seems to not be set with all of those methods.

I tried searching to see if this was a known issue but didn't see anything come up. Would be great if I could set these values somehow 👍

@Tam
Copy link

Tam commented Mar 15, 2017

+1

@tmcw
Copy link
Member

tmcw commented Apr 21, 2017

This is essentially the gist of #406

I think the intent is:

  • If a project-name is provided, use that
  • If a project-name is not provided and there is a nearby package.json, use that
  • If a project-name is not provided and there is one input file, use its name

And

  • If someone wants to not use package.json or the input filename, they can set --project-name=""

Does that sound right? I want to make this convenient, but also explicit - otherwise there could be automatic behavior that's hard to manually override.

@thedark1337
Copy link
Author

Yes, that does sound correct to me 👍

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

No branches or pull requests

3 participants