Downgrade mkdocstrings and mkdocs-autorefs versions (#1760)

* Downgrade mkdocstrings and mkdocs-autorefs versions * Update docs * Update comments in pyproject
airtai · Sep 5, 2024 · d74b370 · d74b370
1 parent 33aeeb2
commit d74b370
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/docs/docs/SUMMARY.md b/docs/docs/SUMMARY.md
@@ -370,6 +370,7 @@ search:
                     - router
                         - [StreamRouter](api/faststream/broker/fastapi/router/StreamRouter.md)
                 - message
+                    - [AckStatus](api/faststream/broker/message/AckStatus.md)
                     - [StreamMessage](api/faststream/broker/message/StreamMessage.md)
                     - [decode_message](api/faststream/broker/message/decode_message.md)
                     - [encode_message](api/faststream/broker/message/encode_message.md)

diff --git a/docs/docs/en/api/faststream/broker/message/AckStatus.md b/docs/docs/en/api/faststream/broker/message/AckStatus.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.broker.message.AckStatus
diff --git a/pyproject.toml b/pyproject.toml
@@ -82,7 +82,8 @@ devdocs = [
     "mkdocs-material==9.5.34",
     "mkdocs-static-i18n==1.2.3",
     "mdx-include==1.4.2",
-    "mkdocstrings[python]==0.26.0",
+    "mkdocstrings[python]==0.25.2",                     # mkdocstrings[python] and mkdocs-autorefs are pinned until following autoref issue is fixed
+    "mkdocs-autorefs==1.1.0",                           # https://github.com/mkdocstrings/autorefs/issues/57
     "mkdocs-literate-nav==0.6.1",
     "mkdocs-git-revision-date-localized-plugin==1.2.7",
     "mike==2.1.3",                                      # versioning