diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index dd3eab67f4a..30c6a8becdc 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -3,6 +3,8 @@ source: cli/tests/test_generate_md_cli_help.rs description: "AUTO-GENERATED FILE, DO NOT EDIT. This cli reference is generated as an `insta` snapshot. MkDocs follows they symlink from docs/cli-reference.md to the snap. Unfortunately, `insta` unavoidably creates this header. Luckily, MkDocs ignores the header since it has the same format as Markdown headers. TODO: MkDocs may fail on Windows if symlinks are not enabled in the OS settings" --- + + !!! warning This CLI reference is experimental. It is automatically generated, but diff --git a/cli/tests/test_generate_md_cli_help.rs b/cli/tests/test_generate_md_cli_help.rs index 4b69a8eb2e9..193c0605890 100644 --- a/cli/tests/test_generate_md_cli_help.rs +++ b/cli/tests/test_generate_md_cli_help.rs @@ -17,6 +17,8 @@ use insta::assert_snapshot; use crate::common::TestEnvironment; const PREAMBLE: &str = r#" + + !!! warning This CLI reference is experimental. It is automatically generated, but diff --git a/docs/cli-reference.md b/docs/cli-reference.md deleted file mode 120000 index 57873d86bb1..00000000000 --- a/docs/cli-reference.md +++ /dev/null @@ -1 +0,0 @@ -../cli/tests/cli-reference@.md.snap \ No newline at end of file diff --git a/docs/cli-reference.md b/docs/cli-reference.md new file mode 100644 index 00000000000..276745e5bf4 --- /dev/null +++ b/docs/cli-reference.md @@ -0,0 +1,16 @@ + + + + +{% + include-markdown "../cli/tests/cli-reference@.md.snap" + rewrite-relative-urls=false + start="" +%} + diff --git a/mkdocs-offline.yml b/mkdocs-offline.yml index 3704e86b602..b4f28bd1523 100644 --- a/mkdocs-offline.yml +++ b/mkdocs-offline.yml @@ -2,6 +2,8 @@ # your file system. To use, run: # poetry run -- mkdocs build -f mkdocs-offline.yml INHERIT: 'mkdocs.yml' +# TODO: The CLI reference is not currently generated correctly +# https://github.com/squidfunk/mkdocs-material/issues/6749 plugins: - offline # Turns out the `offline` plugin forces the following