gir icon indicating copy to clipboard operation
gir copied to clipboard

Fixed the command to generate the docs

Open pentamassiv opened this issue 3 years ago • 5 comments
trafficstars

pentamassiv avatar Apr 11 '22 00:04 pentamassiv

It should probably also mention the generator.py script with --embed-docs / --strip-docs options.

bilelmoussaoui avatar Apr 11 '22 09:04 bilelmoussaoui

I believe the "Generating documentation" should also not be it's own chapter but be part 3.4 of the tutorial.

pentamassiv avatar Apr 13 '22 20:04 pentamassiv

The generator.py script is for regenerating the bindings and the wrapper one you've created the Git.toml files and all that and there is a new .gir file, right? I could write a few sentences about it if you'd like me to.

pentamassiv avatar Apr 13 '22 20:04 pentamassiv

The generator.py script is for regenerating the bindings and the wrapper one you've created the Git.toml files and all that and there is a new .gir file, right? I could write a few sentences about it if you'd like me to.

Yes but it can also be used to generate the docs making usage of the gir directly unnecessary in general, but both should be documented.

There is already a small section about the generator.py script in the first page of the book https://gtk-rs.org/gir/book/introduction.html#helpers

bilelmoussaoui avatar Apr 24 '22 19:04 bilelmoussaoui

This is incorporated in the PR https://github.com/gtk-rs/gir/pull/1379 and can be closed if it is merged

pentamassiv avatar Sep 21 '22 21:09 pentamassiv