Documentation fails to generate on docs.rs

[roxwize]

I tried going to docs.rs/granite-rs to look at all of the symbols for this library but it appears the builds have been failing since version 0.2.0. Here are the logs:

https://docs.rs/crate/granite-rs/1.3.0/builds/1297643

It appears the Docker container in charge of generating the documentation fails due to missing system libraries.

[davidmhewitt]

Ah, yep, it's failing because the Docker container doesn't have Granite and probably other libraries like GTK etc...

I don't have any control over that Docker container. But this library is largely autogenerated by gir, and the guide states:

For building the docs on systems without the required dependencies installed (for example docs.rs or CI jobs), you can use the docsrs attribute. This will disable the linking of the underlying C libraries and won't throw an error if those libraries are not available.

As far as I can tell, I am using the docsrs attribute, and following the template provided by gir, so I'm not entirely sure what's going wrong.

However, I haven't spent a lot of time looking at it, as the API is essentially identical to Granite, so you could refer to granite Valadoc and get a "good enough" docs experience.