go doc for private github repositories

[t...@catalyst-zero.com]

hey there,

sorry for the noice, but I am wondering how to use godoc.org for private github repositories. is that possible at all? godoc.org is really cool, but some of us cannot do without private repo's. the command `godoc` seems not to be what I want, because I need to compile the documentation by myself every time again, and so need to do others. 

thanks 

[Justin Israel]

That doesn't make sense to me. You want godoc.org to generate public  documentation from a private source repo it can't access, for a package that public users can't use?

--
You received this message because you are subscribed to the Google Groups "golang-nuts" group.
To unsubscribe from this group and stop receiving emails from it, send an email to golang-nuts...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

[Tim Schindler]

I thought there is maybe a feature inside godoc.org that allows private docs for private repos. there is currently nothing like that. never mind.

[bga...@golang.org]

On Friday, January 24, 2014 3:32:58 PM UTC-5, Tim Schindler wrote:

the command `godoc` seems not to be what I want, because I need to compile the documentation by myself every time again, and so need to do others. 

How did you try using godoc?

You should be able to point it at a source directory and run a web server that will generate docs from the source files. 

[DisposaBoy]

Download and run it locally?https://github.com/garyburd/gddo

[Dmitri Shuralyov]

It is possible, but you have to do a bit of work to set it up.

You'd have to run a local copy of the godoc.org server (https://github.com/garyburd/gddo). Presumably, you'd want to make sure that server is private (either behind firewall, or http auth, etc.), else your private repo docs will be public.

In order for your gddo server to be able to access your private repos, you'll need to do GitHub authentication with an account that has access. See sample code here on how to set that up: https://github.com/garyburd/gddo/pull/143#issuecomment-31943180

Finally, optionally, if you don't want your private godoc server to needlessly try to index all the public repos that are already indexed on godoc.org anyway, you could put it behind a little router program that reverse proxies into godoc.org for all public requests (effectively the same as going to godoc.org yourself) and uses your private godoc server for your private repos: https://gist.github.com/shurcooL/8310340

[lytsai]

Dmitri, could it be possible to relink to the sample code on setting up GitHub authentication with an account that has access? It seems like the current link (and the one for the router program) are down.

In addition, would running a local copy of the server be set up following the instructions here? https://github.com/golang/gddo/wiki/Development-Environment-Setup

Thanks!

[prateek papriwal]

Try out https://rocro.com/docstand. You can simply signin (https://docstand.rocro.com/signin) and register your private repository. And then whenever you push new commits to your repo, your documentation is updated (continuous documentation).