Skip to content

Commit 5b11e71

Browse files
committed
Update documentation.
1 parent c30ba68 commit 5b11e71

29 files changed

+99
-104
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
python-version: '3.12'
3131

3232
- name: Install MkDocs and dependencies
33-
run: pip install mkdocs-material
33+
run: pip install mkdocs-material mkdocs-awesome-pages-plugin
3434

3535
- name: Build docs
3636
run: mkdocs build

docs/.pages

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
nav:
2+
- Home: index.md
3+
- Installation: installation.md
4+
- Usage Guide: usage.md
5+
- Examples: examples.md
6+
- API Reference: api
7+
- About Rice: about-rice.md

docs/api/.pages

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
nav:
2+
- Bmp
3+
- Rice
4+
- Std

docs/api/Bmp/.pages

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
nav:
2+
- Bitmap.md
3+
- BitmapHeader.md
4+
- Exception.md
5+
- Pixel.md

docs/api/Bmp/Bitmap.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ initialize(filename: [String](https://docs.ruby-lang.org/en/master/String.html))
88

99

1010
## Methods
11-
\!() -> [TrueClass](https://docs.ruby-lang.org/en/master/TrueClass.html)
11+
\! -> [TrueClass](https://docs.ruby-lang.org/en/master/TrueClass.html)
1212

1313
!=(image: Bmp::Bitmap) -> [TrueClass](https://docs.ruby-lang.org/en/master/TrueClass.html)
1414

@@ -34,42 +34,42 @@ draw_rect(x: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y: [I
3434

3535
draw_triangle(x1: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y1: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), x2: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y2: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), x3: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y3: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), color: Bmp::Pixel) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
3636

37-
empty?() -> [TrueClass](https://docs.ruby-lang.org/en/master/TrueClass.html)
37+
empty? -> [TrueClass](https://docs.ruby-lang.org/en/master/TrueClass.html)
3838

3939
fill_circle(center_x: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), center_y: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), radius: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), color: Bmp::Pixel) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
4040

4141
fill_rect(x: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), width: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), height: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), color: Bmp::Pixel) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
4242

4343
fill_triangle(x1: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y1: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), x2: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y2: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), x3: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y3: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), color: Bmp::Pixel) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
4444

45-
flip_h() -> Bmp::Bitmap
45+
flip_h -> Bmp::Bitmap
4646

47-
flip_v() -> Bmp::Bitmap
47+
flip_v -> Bmp::Bitmap
4848

4949
get(x: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y: [Integer](https://docs.ruby-lang.org/en/master/Integer.html)) -> Bmp::Pixel
5050

5151
get(x: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y: [Integer](https://docs.ruby-lang.org/en/master/Integer.html)) -> Bmp::Pixel
5252

53-
height() -> [Integer](https://docs.ruby-lang.org/en/master/Integer.html)
53+
height -> [Integer](https://docs.ruby-lang.org/en/master/Integer.html)
5454

5555
initialize_copy(other: Bmp::Bitmap) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
5656

57-
inspect() -> [String](https://docs.ruby-lang.org/en/master/String.html)
57+
inspect -> [String](https://docs.ruby-lang.org/en/master/String.html)
5858

5959
load(filename: [Std::Filesystem::Path](https://en.cppreference.com/w/cpp/filesystem/path.html)) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
6060

61-
rotate_90_left() -> Bmp::Bitmap
61+
rotate_90_left -> Bmp::Bitmap
6262

63-
rotate_90_right() -> Bmp::Bitmap
63+
rotate_90_right -> Bmp::Bitmap
6464

6565
save(filename: [Std::Filesystem::Path](https://en.cppreference.com/w/cpp/filesystem/path.html)) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
6666

6767
set(x: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), y: [Integer](https://docs.ruby-lang.org/en/master/Integer.html), color: Bmp::Pixel) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
6868

69-
size() -> [Integer](https://docs.ruby-lang.org/en/master/Integer.html)
69+
size -> [Integer](https://docs.ruby-lang.org/en/master/Integer.html)
7070

71-
to_s() -> [String](https://docs.ruby-lang.org/en/master/String.html)
71+
to_s -> [String](https://docs.ruby-lang.org/en/master/String.html)
7272

73-
width() -> [Integer](https://docs.ruby-lang.org/en/master/Integer.html)
73+
width -> [Integer](https://docs.ruby-lang.org/en/master/Integer.html)
7474

7575

docs/api/Bmp/BitmapHeader.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,3 @@ x_pixels_per_meter: [Integer](https://docs.ruby-lang.org/en/master/Integer.html)
3737
y_pixels_per_meter: [Integer](https://docs.ruby-lang.org/en/master/Integer.html) (read/write)
3838

3939

40-
## Methods
41-

docs/api/Bmp/Exception.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@
33
initialize(message: [String](https://docs.ruby-lang.org/en/master/String.html))
44

55

6-
## Methods
7-

docs/api/Bmp/Pixel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ r: [String](https://docs.ruby-lang.org/en/master/String.html) (read/write)
2222

2323
assign(arg_0: Bmp::Pixel) -> [NilClass](https://docs.ruby-lang.org/en/master/NilClass.html)
2424

25-
inspect() -> [String](https://docs.ruby-lang.org/en/master/String.html)
25+
inspect -> [String](https://docs.ruby-lang.org/en/master/String.html)
2626

27-
to_s() -> [String](https://docs.ruby-lang.org/en/master/String.html)
27+
to_s -> [String](https://docs.ruby-lang.org/en/master/String.html)
2828

2929

docs/api/Bmp/index.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api/Rice/.pages

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
nav:
2+
- Arg.md
3+
- Buffer≺Rice꞉꞉detail꞉꞉ParameterAbstract∗≻.md
4+
- Buffer≺char≻.md
5+
- ModuleRegistry.md
6+
- Native.md
7+
- NativeKind.md
8+
- NativeRegistry.md
9+
- Parameter.md
10+
- Pointer≺Rice꞉꞉detail꞉꞉ParameterAbstract∗≻.md
11+
- Pointer≺char≻.md
12+
- Registries.md
13+
- TypeRegistry.md

0 commit comments

Comments
 (0)