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

Activate dox feature wherever available #778

Closed
wants to merge 0 commits into from
Closed

Activate dox feature wherever available #778

wants to merge 0 commits into from

Conversation

pentamassiv
Copy link
Contributor

Whenever a crate is published on crates.io, its documentation is automatically built on docs.rs regardless of the documentation field in the Cargo.toml file. On docs.rs it is possible to look at all previous versions. This is why there is value in having working builds on docs.rs. Having broken builds on docs.rs also prevents crates using that library from providing their documentation on docs.rs. Analogous to https://gitlab.gnome.org/World/Rust/libadwaita-rs/-/merge_requests/50, I enabled the dox feature wherever it is available to ensure the docs always build, even if the dependencies are not available.

I also fixed a broken link in the documentation

@@ -21,7 +21,7 @@ shell-words = "1.0.0"
tempfile = "3"

[features]
dox = []
dox = ["glib/dox", "gio/dox", "gobject/dox"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You will have to teach gir as it is what generates the sys/Cargo.toml to do this automatically.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I'll try that instead.

@pentamassiv
Copy link
Contributor Author

Fixed, since #798 was merged

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