Skip to content
This repository was archived by the owner on Mar 4, 2024. It is now read-only.

Commit 743fe6d

Browse files
Remove doc generation features
1 parent 03e65e0 commit 743fe6d

28 files changed

+20
-563
lines changed

.github/workflows/CI.yml

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -65,19 +65,6 @@ jobs:
6565
- run: ./check_init_asserts ../${{matrix.conf.name}}
6666
working-directory: checker
6767
if: matrix.rust == 'nightly' && (matrix.conf.name == 'atk' || matrix.conf.name == 'gdk' || matrix.conf.name == 'gdkx11' || matrix.conf.name == 'gtk')
68-
# rustdoc-stripper
69-
- name: doc add
70-
run: cargo build --manifest-path ${{ matrix.conf.name }}/Cargo.toml --features "dox,embed-lgpl-docs"
71-
if: matrix.rust == 'nightly' && matrix.conf.name != 'glib'
72-
- name: doc removal
73-
run: cargo build --manifest-path ${{ matrix.conf.name }}/Cargo.toml --features "purge-lgpl-docs"
74-
if: matrix.rust == 'nightly' && matrix.conf.name != 'glib'
75-
- name: glib doc check
76-
run: cargo build --manifest-path ${{ matrix.conf.name }}/Cargo.toml --features "dox"
77-
if: matrix.rust == 'nightly' && matrix.conf.name == 'glib'
78-
- name: check diff
79-
run: git diff -R --exit-code
80-
if: matrix.rust == 'nightly'
8168
# tests run
8269
- name: tests nightly
8370
run: xvfb-run --auto-servernum cargo test --manifest-path ${{ matrix.conf.name }}/Cargo.toml ${{ matrix.conf.nightly }}

.github/workflows/docs.yml

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,13 @@ jobs:
2222
override: true
2323
- working-directory: gir
2424
run: cargo build --release
25-
- run: ./gir/target/release/gir -c ./atk/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
26-
- run: ./gir/target/release/gir -c ./gdk/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
27-
- run: ./gir/target/release/gir -c ./gdk-pixbuf/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
28-
- run: ./gir/target/release/gir -c ./gdkx11/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
29-
- run: ./gir/target/release/gir -c ./gio/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
30-
- run: ./gir/target/release/gir -c ./graphene/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
31-
- run: ./gir/target/release/gir -c ./gtk/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
32-
- run: ./gir/target/release/gir -c ./pango/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
33-
- run: ./gir/target/release/gir -c ./pangocairo/Gir.toml -d ./gir-files --doc-target-path docs.md -m doc
25+
- run: rustup component add rustfmt
3426
- run: cargo install rustdoc-stripper
35-
- run: rustdoc-stripper -g -o ./atk/docs.md
36-
- run: rustdoc-stripper -g -o ./gdk/docs.md
37-
- run: rustdoc-stripper -g -o ./gdk-pixbuf/docs.md
38-
- run: rustdoc-stripper -g -o ./gdkx11/docs.md
39-
- run: rustdoc-stripper -g -o ./gio/docs.md
40-
- run: rustdoc-stripper -g -o ./graphene/docs.md
41-
- run: rustdoc-stripper -g -o ./gtk/docs.md
42-
- run: rustdoc-stripper -g -o ./pango/docs.md
43-
- run: rustdoc-stripper -g -o ./pangocairo/docs.md
27+
- run: python3 ./generator.py --embed-docs --yes ./
4428
- uses: actions-rs/cargo@v1
4529
with:
4630
command: doc
47-
args: -p atk -p atk-sys -p cairo-rs -p cairo-sys-rs -p gdk -p gdk-sys -p gdk-pixbuf -p gdk-pixbuf-sys -p gdkx11 -p gdkx11-sys -p gio -p gio-sys -p glib -p gobject-sys -p glib-sys -p glib-macros -p graphene-rs -p graphene-sys -p gtk -p gtk3-macros -p gtk-sys -p pango -p pango-sys -p pangocairo -p pangocairo-sys --features "dox,embed-lgpl-docs" --no-deps
31+
args: -p atk -p atk-sys -p cairo-rs -p cairo-sys-rs -p gdk -p gdk-sys -p gdk-pixbuf -p gdk-pixbuf-sys -p gdkx11 -p gdkx11-sys -p gio -p gio-sys -p glib -p gobject-sys -p glib-sys -p glib-macros -p graphene-rs -p graphene-sys -p gtk -p gtk3-macros -p gtk-sys -p pango -p pango-sys -p pangocairo -p pangocairo-sys --features dox --no-deps
4832
env:
4933
RUSTDOCFLAGS: "--enable-index-page -Zunstable-options"
5034

atk/Cargo.toml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ readme = "README.md"
1010
version = "0.13.0"
1111
keywords = ["atk", "gtk-rs", "gnome", "accessibility"]
1212
repository = "https://github.com/gtk-rs/gtk-rs"
13-
build = "build.rs"
1413
exclude = [
1514
"gir-files/*",
1615
]
@@ -20,20 +19,13 @@ edition = "2018"
2019
name = "atk"
2120

2221
[features]
23-
purge-lgpl-docs = ["gtk-rs-lgpl-docs"]
24-
embed-lgpl-docs = ["gtk-rs-lgpl-docs"]
2522
dox = ["ffi/dox"]
2623
v2_30 = ["ffi/v2_30"]
2724
v2_32 = ["v2_30", "ffi/v2_32"]
2825
v2_34 = ["v2_32", "ffi/v2_34"]
2926

3027
[package.metadata.docs.rs]
31-
features = ["dox", "embed-lgpl-docs"]
32-
33-
[build-dependencies.gtk-rs-lgpl-docs]
34-
version = "0.1"
35-
optional = true
36-
git = "https://github.com/gtk-rs/lgpl-docs"
28+
features = ["dox"]
3729

3830
[dependencies]
3931
libc = "0.2"

atk/build.rs

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

cairo/Cargo.toml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,17 @@ documentation = "https://gtk-rs.org/docs/cairo/"
99
version = "0.13.0"
1010
description = "Rust bindings for the Cairo library"
1111
repository = "https://github.com/gtk-rs/gtk-rs"
12-
build = "build.rs"
1312
edition = "2018"
1413

1514
[lib]
1615
name = "cairo"
1716

1817
[features]
19-
purge-lgpl-docs = ["gtk-rs-lgpl-docs"]
2018
png = ["ffi/png"]
2119
pdf = ["ffi/pdf"]
2220
svg = ["ffi/svg"]
2321
ps = ["ffi/ps"]
2422
use_glib = ["glib", "ffi/use_glib"]
25-
embed-lgpl-docs = ["gtk-rs-lgpl-docs"]
2623
v1_14 = ["ffi/v1_14"]
2724
v1_16 = ["v1_14", "ffi/v1_16"]
2825
default = ["use_glib"]
@@ -34,12 +31,7 @@ dox = ["ffi/dox", "glib/dox", "freetype"]
3431
win32-surface = ["ffi/win32-surface"]
3532

3633
[package.metadata.docs.rs]
37-
features = ["dox", "embed-lgpl-docs"]
38-
39-
[build-dependencies.gtk-rs-lgpl-docs]
40-
version = "0.1.8"
41-
optional = true
42-
git = "https://github.com/gtk-rs/lgpl-docs"
34+
features = ["dox"]
4335

4436
[dependencies.glib]
4537
optional = true

cairo/build.rs

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

cairo/src/lib.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525
//!
2626
//! ### Documentation features
2727
//!
28-
//! * **embed-lgpl-docs** - Embed API docs locally
29-
//! * **purge-lgpl-docs** - Remove API docs again (counterpart to `embed-lgpl-docs`)
3028
//! * **dox** - Used to keep system dependent items in documentation
3129
//!
3230
//! ### X Window features

gdk-pixbuf/Cargo.toml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ documentation = "https://gtk-rs.org/docs/gdk_pixbuf/"
99
version = "0.13.0"
1010
description = "Rust bindings for the GdkPixbuf library"
1111
repository = "https://github.com/gtk-rs/gtk-rs"
12-
build = "build.rs"
1312
exclude = [
1413
"gir-files/*",
1514
]
@@ -24,16 +23,9 @@ v2_36 = ["v2_32", "ffi/v2_36"]
2423
v2_36_8 = ["v2_36", "ffi/v2_36_8"]
2524
v2_40 = ["v2_36_8", "ffi/v2_40"]
2625
dox = ["glib/dox", "ffi/dox"]
27-
purge-lgpl-docs = ["gtk-rs-lgpl-docs"]
28-
embed-lgpl-docs = ["gtk-rs-lgpl-docs"]
2926

3027
[package.metadata.docs.rs]
31-
features = ["dox", "embed-lgpl-docs"]
32-
33-
[build-dependencies.gtk-rs-lgpl-docs]
34-
version = "0.1"
35-
optional = true
36-
git = "https://github.com/gtk-rs/lgpl-docs"
28+
features = ["dox"]
3729

3830
[dependencies]
3931
libc = "0.2"

gdk-pixbuf/build.rs

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

gdk/Cargo.toml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ documentation = "https://gtk-rs.org/docs/gdk/"
99
version = "0.13.0"
1010
description = "Rust bindings for the GDK 3 library"
1111
repository = "https://github.com/gtk-rs/gtk-rs"
12-
build = "build.rs"
1312
exclude = [
1413
"gir-files/*",
1514
]
@@ -25,16 +24,9 @@ v3_20 = ["v3_18", "ffi/v3_20"]
2524
v3_22 = ["v3_20", "ffi/v3_22"]
2625
v3_24 = ["v3_22", "ffi/v3_24"]
2726
dox = ["ffi/dox", "glib/dox", "gio/dox", "gdk-pixbuf/dox", "cairo-rs/dox", "pango/dox"]
28-
purge-lgpl-docs = ["gtk-rs-lgpl-docs", "cairo-rs/purge-lgpl-docs", "gdk-pixbuf/purge-lgpl-docs", "gio/purge-lgpl-docs"]
29-
embed-lgpl-docs = ["gtk-rs-lgpl-docs", "cairo-rs/embed-lgpl-docs", "gdk-pixbuf/embed-lgpl-docs", "gio/embed-lgpl-docs"]
3027

3128
[package.metadata.docs.rs]
32-
features = ["dox", "embed-lgpl-docs"]
33-
34-
[build-dependencies.gtk-rs-lgpl-docs]
35-
version = "0.1"
36-
optional = true
37-
git = "https://github.com/gtk-rs/lgpl-docs"
29+
features = ["dox"]
3830

3931
[dependencies]
4032
libc = "0.2"

gdk/build.rs

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

gdkx11/Cargo.toml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ documentation = "https://gtk-rs.org/docs/gdkx11/"
99
version = "0.13.0"
1010
description = "Rust bindings for the GDK X11 library"
1111
repository = "https://github.com/gtk-rs/gtk-rs"
12-
build = "build.rs"
1312
exclude = [
1413
"gir-files/*",
1514
]
@@ -19,19 +18,13 @@ edition = "2018"
1918
name = "gdkx11"
2019

2120
[features]
22-
purge-lgpl-docs = ["gtk-rs-lgpl-docs", "gdk/purge-lgpl-docs"]
23-
embed-lgpl-docs = ["gtk-rs-lgpl-docs", "gdk/embed-lgpl-docs"]
2421
dox = ["gdk/dox", "ffi/dox"]
2522
v3_16 = ["ffi/v3_16", "gdk/v3_16"]
2623
v3_22 = ["v3_16", "ffi/v3_22", "gdk/v3_22"]
2724
v3_24 = ["v3_22", "ffi/v3_24_2"]
2825

29-
[build-dependencies.gtk-rs-lgpl-docs]
30-
optional = true
31-
git = "https://github.com/gtk-rs/lgpl-docs"
32-
3326
[package.metadata.docs.rs]
34-
features = ["dox", "embed-lgpl-docs"]
27+
features = ["dox"]
3528

3629
[dependencies]
3730
libc = "0.2"

gdkx11/build.rs

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

0 commit comments

Comments
 (0)