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

Fixed the command to generate the docs #1347

Closed
wants to merge 1 commit into from
Closed

Fixed the command to generate the docs #1347

wants to merge 1 commit into from

Conversation

pentamassiv
Copy link
Contributor

No description provided.

@bilelmoussaoui
Copy link
Member

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

@pentamassiv
Copy link
Contributor Author

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

@pentamassiv
Copy link
Contributor Author

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 pentamassiv reopened this Apr 13, 2022
@bilelmoussaoui
Copy link
Member

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

@pentamassiv
Copy link
Contributor Author

This is incorporated in the PR #1379 and can be closed if it is merged

@pentamassiv pentamassiv deleted the patch-1 branch February 9, 2023 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants