From 2b76bf8330a99fcc253cdee8fd326e4c4bba6723 Mon Sep 17 00:00:00 2001 From: Felix Krull Date: Thu, 18 Oct 2018 21:58:56 +0200 Subject: [PATCH] Add back API docs merge to Makefile I guess we can't do it as part of the crate, so we do it separately. --- rust-bindings/rust/.gitlab-ci.yml | 3 ++- rust-bindings/rust/Makefile | 9 +++++++++ rust-bindings/rust/conf/libostree.toml | 1 + 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/rust-bindings/rust/.gitlab-ci.yml b/rust-bindings/rust/.gitlab-ci.yml index a05850d6..55786322 100644 --- a/rust-bindings/rust/.gitlab-ci.yml +++ b/rust-bindings/rust/.gitlab-ci.yml @@ -42,8 +42,9 @@ libostree_nightly: docs: stage: docs script: + - make merge-lgpl-docs - cd libostree - - cargo doc --verbose --features "dox lgpl-docs" + - cargo doc --verbose --features dox artifacts: paths: - target/doc diff --git a/rust-bindings/rust/Makefile b/rust-bindings/rust/Makefile index f0ae0b70..94b65b55 100644 --- a/rust-bindings/rust/Makefile +++ b/rust-bindings/rust/Makefile @@ -21,6 +21,15 @@ generate-libostree-sys: gir/libostree-sys generate-libostree: gir/libostree +# -- LGPL docs generation -- +tools/bin/rustdoc-stripper: + cargo install --root tools -- rustdoc-stripper + +merge-lgpl-docs: tools/bin/gir tools/bin/rustdoc-stripper + tools/bin/gir -c conf/libostree.toml -m doc + tools/bin/rustdoc-stripper -g -o target/vendor.md + + # -- gir file management -- update-gir-files: \ remove-gir-files \ diff --git a/rust-bindings/rust/conf/libostree.toml b/rust-bindings/rust/conf/libostree.toml index 7bd1ae1b..1b87167d 100644 --- a/rust-bindings/rust/conf/libostree.toml +++ b/rust-bindings/rust/conf/libostree.toml @@ -3,6 +3,7 @@ work_mode = "normal" library = "OSTree" version = "1.0" target_path = "../libostree" +doc_target_path = "../target/vendor.md" deprecate_by_min_version = true girs_dir = "../gir-files"