From 67bf1084c02b4021260aa0e25dabdce2df0bf183 Mon Sep 17 00:00:00 2001 From: Derek Bailey Date: Thu, 9 Jan 2025 22:06:12 -0800 Subject: [PATCH] Update docs.yml to install mkdocs-redirects --- .github/workflows/docs.yml | 1 + docs/mkdocs.yml | 7 +++++++ docs/source/contributing.md | 1 + docs/source/cpp.md | 2 ++ 4 files changed, 11 insertions(+) create mode 100644 docs/source/cpp.md diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bcae8fa4cb7..cac8561828b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -32,4 +32,5 @@ jobs: restore-keys: | mkdocs-material- - run: pip install mkdocs-material + - run: pip install mkdocs-redirects - run: mkdocs gh-deploy --force -f docs/mkdocs.yml diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 3e961f8c707..cec8dd08845 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -53,6 +53,11 @@ extra: - icon: fontawesome/brands/x-twitter link: https://twitter.com/dbaileychess +plugins: + # https://github.com/mkdocs/mkdocs-redirects + - redirects: + redirect_maps: + 'flatbuffers_guide_use_cpp.html.md': 'cpp.md' markdown_extensions: @@ -88,6 +93,8 @@ nav: - Overview: "schema.md" - Evolution: "evolution.md" - Grammar: "grammar.md" + - Language Guides: + - C++: "cpp.md" - Advanced: - Annotating Buffers (.afb): "annotation.md" - Contributing: "contributing.md" diff --git a/docs/source/contributing.md b/docs/source/contributing.md index 74461ce244e..a65b60ac5ee 100644 --- a/docs/source/contributing.md +++ b/docs/source/contributing.md @@ -64,6 +64,7 @@ other ways) ``` pip install mkdocs-material +pip install mkdocs-redirects ``` Then, in the `root` directory of flatbuffers, run diff --git a/docs/source/cpp.md b/docs/source/cpp.md new file mode 100644 index 00000000000..a9bb0265cff --- /dev/null +++ b/docs/source/cpp.md @@ -0,0 +1,2 @@ +# Language Guide: C++ +