diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 088cac2ba..9d4f76c30 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -305,7 +305,7 @@ jobs: # allow deprecated warning because we are using nightly and some things might be deprecated in nightly # for which the stable alternative is not yet available RUSTFLAGS: -D warnings -W deprecated - RUSTDOCFLAGS: --html-in-header=/home/runner/work/sixtyfps/sixtyfps/api/sixtyfps-rs/sixtyfps-docs-integration.html -D warnings -W deprecated + RUSTDOCFLAGS: --html-in-header=/home/runner/work/sixtyfps/sixtyfps/api/sixtyfps-rs/sixtyfps-docs-preview.html --html-in-header=/home/runner/work/sixtyfps/sixtyfps/api/sixtyfps-rs/sixtyfps-docs-highlight.html -D warnings -W deprecated SIXTYFPS_NO_QT: 1 CARGO_INCREMENTAL: false MDBOOK_VERSION: 0.4.10 diff --git a/api/sixtyfps-cpp/docs/_templates/layout.html b/api/sixtyfps-cpp/docs/_templates/layout.html index c7eee09ab..8329f8e83 100644 --- a/api/sixtyfps-cpp/docs/_templates/layout.html +++ b/api/sixtyfps-cpp/docs/_templates/layout.html @@ -1,5 +1,5 @@ {% extends "!layout.html" %} {% block scripts %} {{ super() }} -{% include "../../../sixtyfps-rs/sixtyfps-docs-integration.html" %} +{% include "../../../sixtyfps-rs/sixtyfps-docs-preview.html" %} {% endblock %} \ No newline at end of file diff --git a/api/sixtyfps-rs/Cargo.toml b/api/sixtyfps-rs/Cargo.toml index 53f28f00f..74f28c03b 100644 --- a/api/sixtyfps-rs/Cargo.toml +++ b/api/sixtyfps-rs/Cargo.toml @@ -31,4 +31,4 @@ pin-weak = "1" rustc_version = "0.4" [package.metadata.docs.rs] -rustdoc-args = [ "--html-in-header", "sixtyfps-docs-integration.html" ] +rustdoc-args = [ "--html-in-header", "sixtyfps-docs-preview.html", "--html-in-header", "sixtyfps-docs-highlight.html" ] diff --git a/api/sixtyfps-rs/sixtyfps-docs-highlight.html b/api/sixtyfps-rs/sixtyfps-docs-highlight.html new file mode 100644 index 000000000..b0bcc34fb --- /dev/null +++ b/api/sixtyfps-rs/sixtyfps-docs-highlight.html @@ -0,0 +1,40 @@ + + + + + \ No newline at end of file diff --git a/api/sixtyfps-rs/sixtyfps-docs-integration.html b/api/sixtyfps-rs/sixtyfps-docs-preview.html similarity index 58% rename from api/sixtyfps-rs/sixtyfps-docs-integration.html rename to api/sixtyfps-rs/sixtyfps-docs-preview.html index 4ebd14ce2..867649c17 100644 --- a/api/sixtyfps-rs/sixtyfps-docs-integration.html +++ b/api/sixtyfps-rs/sixtyfps-docs-preview.html @@ -1,6 +1,6 @@ - - - - \ No newline at end of file diff --git a/docs/building.md b/docs/building.md index 171ca9b1b..f5c64a451 100644 --- a/docs/building.md +++ b/docs/building.md @@ -125,7 +125,7 @@ html to the documentation with the `--html-in-header` rustdoc flag. Here is how to build the documentation to include preview of the .60 files. ```sh -RUSTDOCFLAGS="--html-in-header=$PWD/api/sixtyfps-rs/sixtyfps-docs-integration.html" cargo +nightly doc --no-deps +RUSTDOCFLAGS="--html-in-header=$PWD/api/sixtyfps-rs/sixtyfps-docs-preview.html --html-in-header=$PWD/api/sixtyfps-rs/sixtyfps-docs-highlight.html" cargo +nightly doc --no-deps ``` ### C++ doc