Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .github/workflows/install-mdbook/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,8 @@ description: Install mdbook with the dependencies we need.
runs:
using: composite
steps:
- name: Ensure cargo-binstall is installed
uses: cargo-bins/cargo-binstall@main

- name: Install mdbook
run: cargo xtask install-tools --binstall
run: cargo xtask install-tools
shell: bash

- name: Install mdbook-pandoc dependencies
Expand Down
76 changes: 76 additions & 0 deletions BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
load("@rules_rust_mdbook//:defs.bzl", "mdbook_toolchain")
load("//:comprehensive_rust.bzl", "comprehensive_rust_book", "comprehensive_rust_translations")
load("//:tool_hub.bzl", "tool_hub")

exports_files(
["book.toml"],
visibility = ["//visibility:public"],
)

mdbook_toolchain(
name = "mdbook_toolchain_impl",
mdbook = "@binaries//:mdbook__mdbook",
visibility = ["//visibility:public"],
)

toolchain(
name = "mdbook_toolchain",
toolchain = ":mdbook_toolchain_impl",
toolchain_type = "@rules_rust_mdbook//:toolchain_type",
visibility = ["//visibility:public"],
)

tool_hub(
name = "mdbook-plugins",
tools = {
"//host_tools:pandoc": "pandoc",
"//mdbook-course": "mdbook-course",
"//mdbook-exerciser": "mdbook-exerciser",
"@binaries//:mdbook-i18n-helpers__mdbook-gettext": "mdbook-gettext",
"@binaries//:mdbook-i18n-helpers__mdbook-xgettext": "mdbook-xgettext",
"@binaries//:mdbook-linkcheck2__mdbook-linkcheck2": "mdbook-linkcheck2",
"@binaries//:mdbook-pandoc__mdbook-pandoc": "mdbook-pandoc",
"@svgbob//:mdbook-svgbob__mdbook-svgbob": "mdbook-svgbob",
},
)

filegroup(
name = "content",
srcs = glob([
"src/**/*.md",
"src/**/*.rs",
]),
visibility = ["//visibility:public"],
)

filegroup(
name = "theme",
srcs = glob(["theme/**"]),
visibility = ["//visibility:public"],
)

comprehensive_rust_book(name = "en")

comprehensive_rust_translations(languages = [
"ar",
"bn",
"da",
"de",
"el",
"es",
"fa",
"fr",
"id",
"it",
"ja",
"ko",
"pl",
"pt-BR",
"ro",
"ru",
"tr",
"uk",
"vi",
"zh-CN",
"zh-TW",
])
80 changes: 70 additions & 10 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ module(
)

bazel_dep(name = "rules_rust", version = "0.70.0")
bazel_dep(name = "rules_rust_mdbook", version = "0.70.0")
bazel_dep(name = "rules_shell", version = "0.8.0")
bazel_dep(name = "toml.bzl", version = "0.4.1")
bazel_dep(name = "yaml.bzl", version = "0.1.2")

# TODO: remove when https://github.com/bazelbuild/rules_rust/pull/4027
# is released, likely in version 0.71.0.
git_override(
module_name = "rules_rust",
commit = "2fd73117cd996410be45259cd95b12c7688226fb",
remote = "https://github.com/bazelbuild/rules_rust.git",
)

git_override(
module_name = "rules_rust_mdbook",
commit = "2fd73117cd996410be45259cd95b12c7688226fb",
remote = "https://github.com/bazelbuild/rules_rust.git",
strip_prefix = "extensions/mdbook",
)

rust = use_extension("@rules_rust//rust:extensions.bzl", "rust")
rust.toolchain(
Expand All @@ -13,6 +32,8 @@ use_repo(rust, "rust_toolchains")

register_toolchains("@rust_toolchains//:all")

register_toolchains("//:mdbook_toolchain")

rust_host_tools = use_extension("@rules_rust//rust:extensions.bzl", "rust_host_tools")
rust_host_tools.host_tools(
name = "rust_host_tools_nightly",
Expand All @@ -35,45 +56,84 @@ crate.from_cargo(
)
use_repo(crate, "crates")

# Repositories for mdbook plugins. Add new plugins to the
# `mdbook_plugins` repository. If this fails due to conflicts in their
# Repositories for binary artifacts. Add new `mdbook` plugins to the
# `binaries` repository, and if this fails due to conflicts in their
# dependencies, isolate it below with additional repositories.
crate.spec(
artifact = "bin",
package = "i18n-report",
repositories = ["binaries"],
version = "0.2.0",
)
crate.spec(
artifact = "bin",
package = "mdbook",
repositories = ["binaries"],
version = "0.5.3",
)
crate.spec(
artifact = "bin",
package = "mdbook-i18n-helpers",
repositories = ["mdbook_plugins"],
repositories = ["binaries"],
version = "0.4.0",
)
crate.spec(
artifact = "bin",
package = "mdbook-linkcheck2",
repositories = ["mdbook_plugins"],
repositories = ["binaries"],
version = "0.12.0",
)
crate.spec(
artifact = "bin",
package = "mdbook-pandoc",
repositories = ["mdbook_plugins"],
repositories = ["binaries"],
version = "0.11.0",
)
crate.from_specs(
name = "mdbook_plugins",
name = "binaries",
generate_binaries = True,
host_tools = "@rust_host_tools_nightly",
)
use_repo(crate, "mdbook_plugins")
use_repo(crate, "binaries")

# mdbook-svgbob depends transitively on sauron-core, which has a
# "=0.3.30" dependency on futures. This conflicts with other plugins.
crate.spec(
artifact = "bin",
package = "mdbook-svgbob",
repositories = ["svgbob_plugin"],
repositories = ["svgbob"],
version = "0.3.0",
)
crate.from_specs(
name = "svgbob_plugin",
name = "svgbob",
generate_binaries = True,
host_tools = "@rust_host_tools_nightly",
)
use_repo(crate, "svgbob_plugin")
use_repo(crate, "svgbob")

# The backdated_sources extension manages the retrieval of historical
# repository states. It ensures that each language's source files
# match its .po file timestamp.
backdated_sources = use_extension("//:backdated_sources.bzl", "backdated_sources")
backdated_sources.language(po = "//po:ar.po")
backdated_sources.language(po = "//po:bn.po")
backdated_sources.language(po = "//po:da.po")
backdated_sources.language(po = "//po:de.po")
backdated_sources.language(po = "//po:el.po")
backdated_sources.language(po = "//po:es.po")
backdated_sources.language(po = "//po:fa.po")
backdated_sources.language(po = "//po:fr.po")
backdated_sources.language(po = "//po:id.po")
backdated_sources.language(po = "//po:it.po")
backdated_sources.language(po = "//po:ja.po")
backdated_sources.language(po = "//po:ko.po")
backdated_sources.language(po = "//po:pl.po")
backdated_sources.language(po = "//po:pt-BR.po")
backdated_sources.language(po = "//po:ro.po")
backdated_sources.language(po = "//po:ru.po")
backdated_sources.language(po = "//po:tr.po")
backdated_sources.language(po = "//po:uk.po")
backdated_sources.language(po = "//po:vi.po")
backdated_sources.language(po = "//po:zh-CN.po")
backdated_sources.language(po = "//po:zh-TW.po")
use_repo(backdated_sources, "backdated_sources")
Loading
Loading