Skip to content

Commit 23cbc54

Browse files
bilelmoussaouibilelmoussaoui
committed
Fix docs for new crates
By adding missing README & doc cfg
1 parent 1174b5d commit 23cbc54

File tree

9 files changed

+185
-2
lines changed

9 files changed

+185
-2
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ jobs:
2323
0.17=0.17
2424
0.16=0.16
2525
RUSTDOCFLAGS: --cfg docsrs -Zunstable-options --generate-link-to-definition
26+
DOCS_RS: 1
2627
steps:
2728
- uses: actions/checkout@v6
2829
with:

‎gio-unix/README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Rust Gio Unix bindings
2+
3+
__Rust__ bindings and wrappers for [gio](https://docs.gtk.org/gio/), part of [gtk-rs-core](https://github.com/gtk-rs/gtk-rs-core).
4+
5+
Gio __2.56__ is the lowest supported version for the underlying library.
6+
7+
## Minimum supported Rust version
8+
9+
Currently, the minimum supported Rust version is `1.83.0`.
10+
11+
## Documentation
12+
13+
* [Rust API - Stable](https://gtk-rs.org/gtk-rs-core/stable/latest/docs/gio_unix/)
14+
* [Rust API - Development](https://gtk-rs.org/gtk-rs-core/git/docs/gio_unix)
15+
* [GTK Installation instructions](https://www.gtk.org/docs/installations/)
16+
17+
## Using
18+
19+
We recommend using [crates from crates.io](https://crates.io/keywords/gtk-rs),
20+
as [demonstrated here](https://gtk-rs.org/#using).
21+
22+
If you want to track the bleeding edge, use the git dependency instead:
23+
24+
```toml
25+
[dependencies]
26+
gio = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "gio" }
27+
```
28+
29+
Avoid mixing versioned and git crates like this:
30+
31+
```toml
32+
# This will not compile
33+
[dependencies]
34+
glib = "0.13"
35+
gio = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "gio" }
36+
```
37+
38+
### See Also
39+
40+
* [glib](https://crates.io/crates/glib)
41+
42+
## License
43+
44+
__gio-unix__ is available under the MIT License, please refer to it.

‎gio-unix/src/lib.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Take a look at the license at the top of the repository in the LICENSE file.
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
3+
#![doc = include_str!("../README.md")]
24

35
pub use ffi;
46

‎gio-win32/README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Rust Gio Win32 bindings
2+
3+
__Rust__ bindings and wrappers for [gio](https://docs.gtk.org/gio/), part of [gtk-rs-core](https://github.com/gtk-rs/gtk-rs-core).
4+
5+
Gio __2.56__ is the lowest supported version for the underlying library.
6+
7+
## Minimum supported Rust version
8+
9+
Currently, the minimum supported Rust version is `1.83.0`.
10+
11+
## Documentation
12+
13+
* [Rust API - Stable](https://gtk-rs.org/gtk-rs-core/stable/latest/docs/gio_win32/)
14+
* [Rust API - Development](https://gtk-rs.org/gtk-rs-core/git/docs/gio_win32)
15+
* [GTK Installation instructions](https://www.gtk.org/docs/installations/)
16+
17+
## Using
18+
19+
We recommend using [crates from crates.io](https://crates.io/keywords/gtk-rs),
20+
as [demonstrated here](https://gtk-rs.org/#using).
21+
22+
If you want to track the bleeding edge, use the git dependency instead:
23+
24+
```toml
25+
[dependencies]
26+
gio = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "gio" }
27+
```
28+
29+
Avoid mixing versioned and git crates like this:
30+
31+
```toml
32+
# This will not compile
33+
[dependencies]
34+
glib = "0.13"
35+
gio = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "gio" }
36+
```
37+
38+
### See Also
39+
40+
* [glib](https://crates.io/crates/glib)
41+
42+
## License
43+
44+
__gio-win32__ is available under the MIT License, please refer to it.

‎gio-win32/src/lib.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Take a look at the license at the top of the repository in the LICENSE file.
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
3+
#![doc = include_str!("../README.md")]
24

35
pub use ffi;
46

‎glib-unix/README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Rust GLib Unix bindings
2+
3+
__Rust__ bindings and wrappers for [glib](https://docs.gtk.org/glib/), part of [gtk-rs-core](https://github.com/gtk-rs/gtk-rs-core).
4+
5+
GLib __2.56__ is the lowest supported version for the underlying library.
6+
7+
## Minimum supported Rust version
8+
9+
Currently, the minimum supported Rust version is `1.83.0`.
10+
11+
## Documentation
12+
13+
* [Rust API - Stable](https://gtk-rs.org/gtk-rs-core/stable/latest/docs/glib_unix/)
14+
* [Rust API - Development](https://gtk-rs.org/gtk-rs-core/git/docs/glib_unix)
15+
* [GTK Installation instructions](https://www.gtk.org/docs/installations/)
16+
17+
## Using
18+
19+
We recommend using [crates from crates.io](https://crates.io/keywords/gtk-rs),
20+
as [demonstrated here](https://gtk-rs.org/#using).
21+
22+
If you want to track the bleeding edge, use the git dependency instead:
23+
24+
```toml
25+
[dependencies]
26+
glib = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "glib" }
27+
```
28+
29+
Avoid mixing versioned and git crates like this:
30+
31+
```toml
32+
# This will not compile
33+
[dependencies]
34+
glib = "0.13"
35+
glib = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "glib" }
36+
```
37+
38+
### See Also
39+
40+
* [gio](https://crates.io/crates/gio)
41+
42+
## License
43+
44+
__glib-unix__ is available under the MIT License, please refer to it.

‎glib-unix/src/lib.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Take a look at the license at the top of the repository in the LICENSE file.
2-
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
3+
#![doc = include_str!("../README.md")]
34
pub use ffi;
45

56
mod auto;

‎glib-win32/README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Rust GLib Win32 bindings
2+
3+
__Rust__ bindings and wrappers for [glib](https://docs.gtk.org/glib/), part of [gtk-rs-core](https://github.com/gtk-rs/gtk-rs-core).
4+
5+
GLib __2.56__ is the lowest supported version for the underlying library.
6+
7+
## Minimum supported Rust version
8+
9+
Currently, the minimum supported Rust version is `1.83.0`.
10+
11+
## Documentation
12+
13+
* [Rust API - Stable](https://gtk-rs.org/gtk-rs-core/stable/latest/docs/glib_win32/)
14+
* [Rust API - Development](https://gtk-rs.org/gtk-rs-core/git/docs/glib_win32)
15+
* [GTK Installation instructions](https://www.gtk.org/docs/installations/)
16+
17+
## Using
18+
19+
We recommend using [crates from crates.io](https://crates.io/keywords/gtk-rs),
20+
as [demonstrated here](https://gtk-rs.org/#using).
21+
22+
If you want to track the bleeding edge, use the git dependency instead:
23+
24+
```toml
25+
[dependencies]
26+
glib = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "glib" }
27+
```
28+
29+
Avoid mixing versioned and git crates like this:
30+
31+
```toml
32+
# This will not compile
33+
[dependencies]
34+
glib = "0.13"
35+
glib = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "glib" }
36+
```
37+
38+
### See Also
39+
40+
* [gio](https://crates.io/crates/gio)
41+
42+
## License
43+
44+
__glib-win32 is available under the MIT License, please refer to it.

‎glib-win32/src/lib.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Take a look at the license at the top of the repository in the LICENSE file.
2-
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
3+
#![doc = include_str!("../README.md")]
34
pub use ffi;
45

56
mod auto;

0 commit comments

Comments
 (0)