Re: [PATCH V7 1/8] libgpiod: Add libgpiod-sys rust crate

[Kent Gibson <warthog618@xxxxxxxxx>]

On Wed, Oct 19, 2022 at 04:52:51PM +0530, Viresh Kumar wrote:
> On 19-10-22, 15:21, Kent Gibson wrote:
> > That doesn't really work - you get a link to the files in github, not
> > as a web site.  You need somewhere that will host those generated files
> > as a web site.  You could do that with github-pages if you don't have other
> > options.
> 
> I don't have other options for now, so it is github.
> 
> > When I've done that I would commit the docs to a separate
> > branch, just for the docs, and have github-pages host that branch.
> 
> Okay.
> 
> > If you eventually publish your crate to crates.io you get documentation on
> > docs.rs for free - and you can skip the documentation key in that case too
> > - it defaults to the appropriate page on docs.rs.
> 
> Right, that I knew.
> 
> > I assume that would be the case long term - you just need to find
> > someway to host them in the meantime.
> 
> I wonder if we should be doing this at all right now, or if required
> only Bartosz should do it instead of me, once this is merged ?
> 

I was assuming it was an interim solution, so it doesn't matter so much.

I'd be happy with docs.rs once libgpiod v2 is released and the bindings
published to crates.io, and I'm personally good with looking at the
generated docs locally in the meantime.

It would be easier for others to take a look if the docs were hosted,
but I don't have any feel as to whether that is worth the effort or not.

> Maybe we need a libgpiod username for that on github ? To make it
> independent of personal usernames ? From what I saw, the website name
> will be username.github.io eventually.
> 

A libgpiod group account might be useful.

And it would be nice to have a libgpiod space somewhere, not just
piggybacking on the gpio mailing list.  Not sure if github is the best
place - but I haven't given it much thought.

Bart, do you have any opinions?

Cheers,
Kent.