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

Cannot generate internal documentation #2229

Closed
osbugs opened this issue Jun 2, 2016 · 5 comments
Closed

Cannot generate internal documentation #2229

osbugs opened this issue Jun 2, 2016 · 5 comments

Comments

@osbugs
Copy link
Contributor

@osbugs osbugs commented Jun 2, 2016

Perhaps I did miss something, but it seems to me that generating internal documentation is not possible.

With cabal, I just use the following command line: cabal haddock --internal. Is there some similar switch for stack?

@osbugs
Copy link
Contributor Author

@osbugs osbugs commented Jun 3, 2016

I think this bug/feature request is distinct from #2165. The difference is that I do not want to provide arguments to haddock but I do want haddock to be run on a different target than the one provided.

@mgsloan mgsloan added this to the P2: Should milestone Jun 3, 2016
@mgsloan
Copy link
Contributor

@mgsloan mgsloan commented Jun 3, 2016

I see! Yes, currently I don't think we have a way to do --internal, but it'd be a great thing to add. Not sure if we want to call it that, though.

I'd almost want to have it be a default, but only if haddock made it clear they're for unexposed modules (doubtful)

rickowens added a commit to rickowens/stack that referenced this issue Aug 23, 2016
)

This is a boolean argument which causes haddocks to be generated in the
same manner as `cabal haddock --internal`, implemented by simply passing
`--internal` to the `cabal haddock` invocation used to build the docs.

It defaults to False.
@rickowens
Copy link

@rickowens rickowens commented Aug 23, 2016

Hi guys. I really needed this for a project I'm working on, so I went ahead and took a swing at it. This is my first contribution to stack, so let me know if there is anything I missed in the way of completeness/style/policy. Thanks.

rickowens added a commit to rickowens/stack that referenced this issue Aug 25, 2016
)

This is a boolean argument which causes haddocks to be generated in the
same manner as `cabal haddock --internal`, implemented by simply passing
`--internal` to the `cabal haddock` invocation used to build the docs.

It defaults to False.
rickowens added a commit to rickowens/stack that referenced this issue Aug 27, 2016
)

This is a boolean argument which causes haddocks to be generated in the
same manner as `cabal haddock --internal`, implemented by simply passing
`--internal` to the `cabal haddock` invocation used to build the docs.

It defaults to False.
rickowens added a commit to rickowens/stack that referenced this issue Aug 31, 2016
)

This is a boolean argument which causes haddocks to be generated in the
same manner as `cabal haddock --internal`, implemented by simply passing
`--internal` to the `cabal haddock` invocation used to build the docs.

It defaults to False.
@osbugs
Copy link
Contributor Author

@osbugs osbugs commented Sep 15, 2016

Updated PR in #2598

sjakobi added a commit that referenced this issue Sep 22, 2016
This is a boolean argument which causes haddocks to be generated in the
same manner as `cabal haddock --internal`, implemented by simply passing
`--internal` to the `cabal haddock` invocation used to build the docs.

It defaults to False.
@sjakobi
Copy link
Member

@sjakobi sjakobi commented Sep 22, 2016

Closed via #2598

@sjakobi sjakobi closed this Sep 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants