Summary
The MkDocs Material site has two related navigation defects on the API Reference → Python API Usage page, plus a broader front-matter inconsistency behind one of them:
- Python API Usage is the only page in the API Reference section that renders a left-hand nav menu. The site convention is to hide the LHS nav (top tabs + in-page links handle navigation);
python.md is missing the hide: navigation front matter its siblings all have.
- The Python API Usage page is not listed in the top-down (left-hand) navigation menu of the MkDocs site, even though
mkdocs.yml declares it under the API Reference section. So the one page that does show a menu is also the page missing from it.
These may share a root cause or be distinct — see Open questions.
Reproduction
- Open the live docs, visit API Reference → C++ API Usage — no left-hand nav menu (expected).
- Visit API Reference → Python API Usage — a left-hand nav tree appears (symptom 1).
- In that menu, note that Python API Usage itself is not listed as an entry (symptom 2).
- The visible-menu mismatch from step 2 also exists across the Benchmarking section and one Tutorials page (see inventory).
Inventory (hide: navigation front matter)
Convention is "hide the LHS nav." Pages that already follow it:
docs/getting-started.md
docs/concepts.md
docs/api-reference/index.md
docs/api-reference/configuration.md
docs/api-reference/cpp.md
docs/tutorials/configuration-walkthrough.md
docs/tutorials/system_configuration.md
Pages missing the front matter (they render a LHS menu out of step with their siblings):
docs/api-reference/python.md ← originally reported; only API Reference page with a LHS menu
docs/benchmarks/benchmarks.md
docs/benchmarks/raw_benchmarking.md
docs/benchmarks/socket_benchmarking.md
docs/tutorials/bare-metal-cmake-build.md
Proposed fix
For symptom 1 and the broader inconsistency, add the standard front matter to the top of each of the 5 pages above:
---
hide:
- navigation
---
docs/tutorials/configuration-walkthrough.md is the precedent that this is the right direction: it hides the LHS nav and keeps a "Previous/Next" footer, so the Benchmarking and bare-metal pages stay uniform without losing their sequential footers.
For symptom 2, confirm mkdocs.yml lists Python API Usage: api-reference/python.md under the API Reference nav block (it currently does), then verify whether the missing menu entry is a side effect of the inconsistent front matter / build state or a separate rendering issue, and fix accordingly.
Open questions
- Is symptom 2 ("not listed in the top-down menu") resolved by the front-matter fix, or is it an independent
mkdocs.yml / theme nav issue? Needs a mkdocs build + render check after the front-matter change.
Acceptance criteria
Summary
The MkDocs Material site has two related navigation defects on the API Reference → Python API Usage page, plus a broader front-matter inconsistency behind one of them:
python.mdis missing thehide: navigationfront matter its siblings all have.mkdocs.ymldeclares it under theAPI Referencesection. So the one page that does show a menu is also the page missing from it.These may share a root cause or be distinct — see Open questions.
Reproduction
Inventory (
hide: navigationfront matter)Convention is "hide the LHS nav." Pages that already follow it:
docs/getting-started.mddocs/concepts.mddocs/api-reference/index.mddocs/api-reference/configuration.mddocs/api-reference/cpp.mddocs/tutorials/configuration-walkthrough.mddocs/tutorials/system_configuration.mdPages missing the front matter (they render a LHS menu out of step with their siblings):
docs/api-reference/python.md← originally reported; only API Reference page with a LHS menudocs/benchmarks/benchmarks.mddocs/benchmarks/raw_benchmarking.mddocs/benchmarks/socket_benchmarking.mddocs/tutorials/bare-metal-cmake-build.mdProposed fix
For symptom 1 and the broader inconsistency, add the standard front matter to the top of each of the 5 pages above:
docs/tutorials/configuration-walkthrough.mdis the precedent that this is the right direction: it hides the LHS nav and keeps a "Previous/Next" footer, so the Benchmarking and bare-metal pages stay uniform without losing their sequential footers.For symptom 2, confirm
mkdocs.ymllistsPython API Usage: api-reference/python.mdunder theAPI Referencenav block (it currently does), then verify whether the missing menu entry is a side effect of the inconsistent front matter / build state or a separate rendering issue, and fix accordingly.Open questions
mkdocs.yml/ theme nav issue? Needs amkdocs build+ render check after the front-matter change.Acceptance criteria
hide: navigation.mkdocs build --strictpasses (CI docs gate stays green).