diff --git a/crates/ruff_dev/src/generate_docs.rs b/crates/ruff_dev/src/generate_docs.rs index f406b12bab..e1ce27360e 100644 --- a/crates/ruff_dev/src/generate_docs.rs +++ b/crates/ruff_dev/src/generate_docs.rs @@ -103,7 +103,7 @@ fn process_documentation(documentation: &str, out: &mut String) { let anchor = option.replace('.', "-"); out.push_str(&format!("- [`{option}`][{option}]\n")); - after.push_str(&format!("[{option}]: ../../settings#{anchor}\n")); + after.push_str(&format!("[{option}]: ../settings.md#{anchor}\n")); continue; } @@ -151,8 +151,8 @@ Something [`else`][other]. [other]: http://example.com. -[task-tags]: ../../settings#task-tags -[mccabe.max-complexity]: ../../settings#mccabe-max-complexity +[task-tags]: ../settings.md#task-tags +[mccabe.max-complexity]: ../settings.md#mccabe-max-complexity " ); } diff --git a/crates/ruff_dev/src/generate_rules_table.rs b/crates/ruff_dev/src/generate_rules_table.rs index 080f7a2a53..7e9d3d9431 100644 --- a/crates/ruff_dev/src/generate_rules_table.rs +++ b/crates/ruff_dev/src/generate_rules_table.rs @@ -61,7 +61,7 @@ pub(crate) fn generate() -> String { table_out.push('\n'); table_out.push_str(&format!( - "The {PREVIEW_SYMBOL} emoji indicates that a rule in [\"preview\"](../faq/#what-is-preview)." + "The {PREVIEW_SYMBOL} emoji indicates that a rule in [\"preview\"](faq.md#what-is-preview)." )); table_out.push('\n'); table_out.push('\n'); diff --git a/docs/requirements-insiders.txt b/docs/requirements-insiders.txt index 20e4c11ad7..f9a7203388 100644 --- a/docs/requirements-insiders.txt +++ b/docs/requirements-insiders.txt @@ -1,4 +1,4 @@ PyYAML==6.0 black==23.3.0 -mkdocs==1.4.3 -git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git +mkdocs==1.5.0 +git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4 diff --git a/docs/requirements.txt b/docs/requirements.txt index db22a4e7cb..b5cb285e06 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ PyYAML==6.0 black==23.3.0 -mkdocs==1.4.3 +mkdocs==1.5.0 mkdocs-material==9.1.18 diff --git a/mkdocs.template.yml b/mkdocs.template.yml index d1ad4c1e5d..a917a25dad 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -51,6 +51,8 @@ plugins: - search extra_css: - stylesheets/extra.css +not_in_nav: | + /rules/* extra: analytics: provider: fathom