Skip to content

Commit 2c30abe

Browse files
Merge pull request #102 from martinber/organization
Website organization
2 parents f0f02c5 + 299afca commit 2c30abe

File tree

10 files changed

+48
-49
lines changed

10 files changed

+48
-49
lines changed

docs-src/index.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ layout: default
33
---
44
# Gtk-rs documentation
55

6-
### [Requirements](requirements.html)
6+
## [Requirements](requirements.html)
77

8-
### Crate API docs
8+
## Crate API docs
99

1010
- [**atk**](../docs/atk/)
1111
- [**cairo**](../docs/cairo/)
@@ -18,7 +18,9 @@ layout: default
1818
- [**pangocairo**](../docs/pangocairo/)
1919
- [**sourceview**](../docs/sourceview/)
2020

21-
### Versions
21+
## [The GTK+ Project documentation](http://www.gtk.org/documentation.php)
22+
23+
## Versions
2224

2325
By default the `gtk` crate provides only GTK+ 3.14 APIs. You can access more
2426
modern APIs by selecting one of the following features: `v3_16`, `v3_18`, `v3_20`, `v3_22`, `v3_24`, `v3_26`, `v3_28`, `v3_30`.
@@ -35,8 +37,8 @@ features = ["v3_16"]
3537
not have easy access to the latest ones.** The higher the version, the fewer
3638
users will have it installed.
3739

38-
### Examples
39-
40-
See the [examples repository](https://github.com/gtk-rs/examples).
40+
## Tutorials and examples
4141

42-
### [The GTK+ Project documentation](http://www.gtk.org/documentation.php)
42+
* [Tutorials](/docs-src/tutorial).
43+
* [Examples repository](https://github.com/gtk-rs/examples).
44+
* [Projects using `gtk-rs`](/#projects-using-gtk-rs).

docs-src/tutorial.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

tuto/closures.md renamed to docs-src/tutorial/closures.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ button.connect_clicked(clone!(windows => move |_| {
150150
```
151151

152152
<div class="footer">
153-
<div><a href="/tuto/version">Specifying version</a>.</div>
153+
<div><a href="./version">Specifying version</a>.</div>
154154
<div><a href="/docs-src/tutorial">Going back to summary</a>.</div>
155-
<div><a href="/tuto/upcast_downcast">Upcast and downcast</a>.</div>
155+
<div><a href="./upcast_downcast">Upcast and downcast</a>.</div>
156156
</div>

tuto/cross.md renamed to docs-src/tutorial/cross.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ then download the windows 10 them from http://b00merang.weebly.com/windows-10.ht
157157
mv Windows-10-master /wherever/release/share/themes/Windows10
158158

159159
<div class="footer">
160-
<div><a href="/tuto/glade">Glade</a>.</div>
160+
<div><a href="./glade">Glade</a>.</div>
161161
<div><a href="/docs-src/tutorial">Going back to summary</a>.</div>
162162
<div></div>
163163
</div>

tuto/glade.md renamed to docs-src/tutorial/glade.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ gtk::main();
133133
```
134134

135135
<div class="footer">
136-
<div><a href="/tuto/upcast_downcast">Upcast and downcast</a>.</div>
136+
<div><a href="./upcast_downcast">Upcast and downcast</a>.</div>
137137
<div><a href="/docs-src/tutorial">Going back to summary</a>.</div>
138-
<div><a href="/tuto/cross">Cross compiling from linux to windows</a>.</div>
138+
<div><a href="./cross">Cross compiling from linux to windows</a>.</div>
139139
<div></div>
140140
</div>

tuto/gnome_and_rust.md renamed to docs-src/tutorial/gnome_and_rust.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The same goes for interfaces. The [gnome documentation](https://developer.gnome.
6262
I think that with this, you'll be able to write anything you want without too much difficulties. Now it's time to go deeper into `Gtk-rs` usage!
6363

6464
<div class="footer">
65-
<div><a href="/tuto/rust_and_gtk">Rust and <code>Gtk-rs</code></a>.</div>
65+
<div><a href="./rust_and_gtk">Rust and <code>Gtk-rs</code></a>.</div>
6666
<div><a href="/docs-src/tutorial">Going back to summary</a>.</div>
67-
<div><a href="/tuto/version">Specifying version</a>.</div>
67+
<div><a href="./version">Specifying version</a>.</div>
6868
</div>

docs-src/tutorial/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
layout: default
3+
---
4+
5+
# Tutorial
6+
7+
## Introduction
8+
9+
Here's an introduction to `Gtk-rs` crates. For the users who already know Rust and Gtk, just skip this part.
10+
11+
* [Rust and `Gtk-rs`](./rust_and_gtk): This part explains how to add dependencies on the `Gtk-rs` crates, depending on your needs.
12+
* [Gnome libraries and Rust](./gnome_and_rust): This part explains a bit how the bindings of the Gnome libraries work in Rust.
13+
14+
## Full usage of `Gtk-rs` crates
15+
16+
In this part we'll go deeper into the mechanisms of the `Gtk-rs` crates. If you're not sure about your Rust or Gnome libraries knowledge, we recommend you to take a look at the previous tutorials first.
17+
18+
* [Specifying version](./version).
19+
* [Callbacks and closures](./closures).
20+
* [Upcast and downcast](./upcast_downcast).
21+
* [Glade](./glade).
22+
* [Cross compiling from linux to windows](./cross).
23+
24+
## Going further
25+
26+
Make sure to check the [examples repository](https://github.com/gtk-rs/examples). Also you can take a look at the source code of [projects using `gtk-rs`](/#projects-using-gtk-rs).

tuto/rust_and_gtk.md renamed to docs-src/tutorial/rust_and_gtk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ layout: default
66

77
Before going any further, if you don't know Rust at all, we recommend you to read the official [Rust Book](https://doc.rust-lang.org/book/).
88

9-
Then we recommend you to learn a bit about [Cargo](http://doc.crates.io/index.html).
9+
Then we recommend you to learn a bit about [Cargo](http://doc.crates.io/index.html) and check the [GTK requirements](/docs-src/requirements).
1010

1111
All done? Perfect!
1212

@@ -55,5 +55,5 @@ Now that you know how to import `Gtk-rs` crates into your code, looking at the [
5555
<div class="footer">
5656
<div></div>
5757
<div><a href="/docs-src/tutorial">Going back to summary</a>.</div>
58-
<div><a href="/tuto/gnome_and_rust">Gnome libraries and Rust</a>.</div>
58+
<div><a href="./gnome_and_rust">Gnome libraries and Rust</a>.</div>
5959
</div>

tuto/upcast_downcast.md renamed to docs-src/tutorial/upcast_downcast.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ assert_eq!(is_a::<_, gtk::Label>(&button), false);
5454
```
5555

5656
<div class="footer">
57-
<div><a href="/tuto/closures">Callbacks and closures</a>.</div>
57+
<div><a href="./closures">Callbacks and closures</a>.</div>
5858
<div><a href="/docs-src/tutorial">Going back to summary</a>.</div>
59-
<div><a href="/tuto/glade">Glade</a>.</div>
59+
<div><a href="./glade">Glade</a>.</div>
6060
</div>

tuto/version.md renamed to docs-src/tutorial/version.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ So when someone has a new enough version of Gtk, it'll be able to build your cra
5656
```
5757

5858
<div class="footer">
59-
<div><a href="/tuto/gnome_and_rust">Gnome libraries and Rust</a>.</div>
59+
<div><a href="./gnome_and_rust">Gnome libraries and Rust</a>.</div>
6060
<div><a href="/docs-src/tutorial">Going back to summary</a>.</div>
61-
<div><a href="/tuto/closures">Callbacks and closures</a>.</div>
61+
<div><a href="./closures">Callbacks and closures</a>.</div>
6262
</div>

0 commit comments

Comments
 (0)