lgpl-docs's Introduction

lgpl-docs

LGPL-licensed docs for Gtk-rs crates.

Structure

The docs for each library come from two files:

docs.rs is maintained manually, its entries take precedence over the vendor.rs file. PRs should normally target this file.
vendor.rs is generated by gir via simple transformation of the upstream docs found in GIR definitions. It serves as a fallback, the docs in it are tailored for C not Rust. This file should not be hand-edited.

You can generate it as follows:

cd gir
cargo run --release -- -c ../your-repo/Gir.toml -d ../gir-files/ -o ../your-repo/ -m doc

Cairo, which lacks GIR definitions, doesn't have a vendor.rs file.

Format

The format of the files is Markdown with extra metadata in HTML-like comments, which ties each entry to a specific Rust item. For example, this rustdoc snippet:

impl Button {
    /// Creates a new `Button` widget. To add a child widget to the button,
    /// use `Container::add`.
    ///
    /// # Returns
    ///
    /// The newly created `Button` widget.
    pub fn new() -> Button {

corresponds to this entry in gtk/vendor.md:

<!-- impl Button::fn new -->
Creates a new `Button` widget. To add a child widget to the button,
use `Container::add`.

# Returns

The newly created `Button` widget.

License

LGPL

lgpl-docs's People

Contributors

Stargazers

Watchers

lgpl-docs's Issues

ListStore list ListStoreExt whereas it should be GtkListStoreExt

The link's href is wrong as well of course.

Clean up the documentation

Hello.
I can see 404 errors on the documentation website.
For intsance, when I search for TreeView and click on gtk::TreeViewExt, I get to this page which is not found.
I think you need to clean up the documentation (delete, then re-generate) to fix this issue.
Thanks.

Add webkit2gtk docs

Currently, the webkit2gtk bindings don't have any published docs. It would be nice to add that as the webkit2gtk crate mentions a 404 docs page.

The "goto source code" `[src]` links lead to "404 - File not found"

On all documentation pages, like for example http://gtk-rs.org/docs/gdk/struct.EventWindowState.html, all links to source code named [src] produce a 404 - File not found page.