import configuration.md from its old location using snippets

DetachHead · Oct 3, 2024 · 692b4f5 · 692b4f5
1 parent dc23c92
commit 692b4f5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/configuration/config-files.md b/docs/configuration/config-files.md
@@ -0,0 +1,6 @@
+<!--
+this file is defined elsewhere and imported here because previous versions of basedpyright contain links to documentation for each diagnostic rule,
+eg. "https://github.com/microsoft/pyright/blob/main/docs/configuration.md#reportGeneralTypeIssues and we don't want to break those links for users
+who haven't yet updated to >=1.18.1
+-->
+--8<-- "docs/configuration.md"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -55,6 +55,8 @@ nav:
   - ...
   - ... | development/**/*.md
   - ... | shoutouts.md
+exclude_docs: |
+  /configuration.md
 repo_url: https://github.com/detachhead/basedpyright
 repo_name: detachhead/basedpyright
 extra_css: