Skip to content

Commit

Permalink
doc: Include CLI ref.
Browse files Browse the repository at this point in the history
  • Loading branch information
kiron1 committed Jan 5, 2025
1 parent 845b9d1 commit 753c934
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 0 deletions.
8 changes: 8 additions & 0 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ bazel_dep(name = "rules_cc", version = "0.1.0")
bazel_dep(name = "rules_pkg", version = "1.0.1")
bazel_dep(name = "rules_rust", version = "0.56.0")

bazel_dep(name = "rules_mdbook", version = "0.0.0")
archive_override(
module_name = "rules_mdbook",
urls = ["https://github.com/kiron1/rules_mdbook/archive/refs/tags/v0.0.1.tar.gz"],
strip_prefix = "rules_mdbook-0.0.1/",
integrity = "sha256-U2ZQ/w89JLBcAbN6gffga5I2HcjGl4SEJG3MrNujlME=",
)

apple_cc_configure = use_extension(
"@build_bazel_apple_support//crosstool:setup.bzl",
"apple_cc_configure_extension",
Expand Down
31 changes: 31 additions & 0 deletions doc/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
load("@rules_mdbook//mdbook:defs.bzl", "md_book")

genrule(
name = "proxydetox_help",
outs = ["proxydetox_help.txt"],
cmd = "$(location //proxydetox) --help > $@",
tools = ["//proxydetox"],
)

md_book(
name = "doc",
srcs = [
"SUMMARY.md",
"alternatives.md",
"build.md",
"configuration.md",
"cross_compile.md",
"developers.md",
"installation.md",
"introduction.md",
"service.md",
"transparent_proxy.md",
"usage.md",
],
authors = ["Kiron"],
data = [
"launchctl.sh",
":proxydetox_help",
],
title = "Proxydetox",
)
4 changes: 4 additions & 0 deletions doc/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,8 @@

---

- [Command Line Reference](cliref.md)

---

[Alternatives](alternatives.md)
7 changes: 7 additions & 0 deletions doc/cliref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Command Line Reference

Following the output of `proxydetox --version` for reference:

```
{{#include proxydetox_help.txt}}
```

0 comments on commit 753c934

Please sign in to comment.