Updating reference docs for new site #25

New Issue

2026-02-16T06:15:50-05:00

yindo commented

2026-02-16 06:15:50 -05:00

Originally created by @mdrxy on GitHub (Oct 9, 2025).

Hello!

This repo is part of LangChain's v0.3 reference documentation. As part of our efforts to consolidate all LangChain projects under one docs site, we are also consolidating the references to this new site. This repo will live at https://reference.langchain.com/python/integrations/langchain_milvus/

As part of the migration, we have switched from using Sphinx/reStructuredText to Material for MkDocs, which is a Markdown-based syntax. Consequently, the inline docstrings and reference docs in the langchain-milvus repo need to be updated accordingly. (Note: existing reference docs are frozen on the v0.3 branch of this repo).

Please update the following:

.. code-block:: {LANGUAGE} admonitions should be translated to standard Markdown codeblocks, e.g.:
```
```language
some code
```
```
URLs with the format `Text to hyperlink <https://link.com>\`__ or `Text to hyperlink <https://link.com>\`_ should be replaced with markdown links like [Text to hyperlink](https://link.com)
Double-backtick inline code like ``inline code`` should be replaced with single backticks like `inline code`
Callout admonitions:
- .. warning::, .. important::, and .. note:: should be updated to !!! warning "Optional title", !!! important, and !!! note respectively. (each can have an optional title). See docs.
- Dropdowns like .. dropdown:: {TITLE} should be replaced with callouts and the ??? syntax. See docs.
.. versionchanged:: x.y.z should be translated to !!! warning "Behavior changed in x.y.z" (with optional descriptions)
.. versionadded:: x.y.z should be translated to !!! version-added "Added in version x.y.z" (with optional descriptions)
.. deprecated:: x.y.z should be translated to !!! deprecated
:private: directives should be removed. New reference docs will automatically exclude methods prefixed with a single underscore, e.g. _function()
- If there are functions that do not use this syntax or can not be updated to use it, we are able to filter out functions by name. Reach out and I can help.
Any cross references with :func:, :class:, or :meth: should be updated to use Markdown links, e.g.: [Runtime][langgraph.runtime.Runtime]

Originally created by @mdrxy on GitHub (Oct 9, 2025). Hello! This repo is part of LangChain's [v0.3 reference documentation](https://python.langchain.com/api_reference/). As part of our efforts to consolidate all LangChain projects under [one docs site](https://docs.langchain.com/), we are also consolidating the references to [this new site](https://reference.langchain.com/python/). This repo will live at https://reference.langchain.com/python/integrations/langchain_milvus/ As part of the migration, we have switched from using Sphinx/reStructuredText to Material for MkDocs, which is a Markdown-based syntax. Consequently, the inline docstrings and reference docs in the `langchain-milvus` repo need to be updated accordingly. (Note: existing reference docs are frozen on the v0.3 branch of this repo). Please update the following: - `.. code-block:: {LANGUAGE}` admonitions should be translated to standard Markdown codeblocks, e.g.: ```` ```language some code ``` ```` - URLs with the format `` `Text to hyperlink <https://link.com>\`__ `` or `` `Text to hyperlink <https://link.com>\`_ `` should be replaced with markdown links like `[Text to hyperlink](https://link.com)` - Double-backtick inline code like ` ``inline code`` ` should be replaced with single backticks like `` `inline code` `` - Callout admonitions: - `.. warning::`, `.. important::`, and `.. note::` should be updated to `!!! warning "Optional title"`, `!!! important`, and `!!! note` respectively. (each can have an optional title). [See docs.](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) - Dropdowns like `.. dropdown:: {TITLE}` should be replaced with callouts and the `???` syntax. [See docs.](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#collapsible-blocks) - `.. versionchanged:: x.y.z` should be translated to `!!! warning "Behavior changed in x.y.z"` (with optional descriptions) - `.. versionadded:: x.y.z` should be translated to `!!! version-added "Added in version x.y.z"` (with optional descriptions) - `.. deprecated:: x.y.z` should be translated to `!!! deprecated` - `:private:` directives should be removed. New reference docs will automatically exclude methods prefixed with a single underscore, e.g. `_function()` - If there are functions that do not use this syntax or can not be updated to use it, we are able to filter out functions by name. Reach out and I can help. - Any cross references with `:func:`, `:class:`, or `:meth:` should be updated to use Markdown links, e.g.: `[Runtime][langgraph.runtime.Runtime]`

yindo closed this issue

2026-02-16 06:15:50 -05:00

yindo commented

2026-02-16 06:15:50 -05:00

@zc277584121 commented on GitHub (Oct 24, 2025):

@mdrxy Thanks for your reminder, here is the update

@zc277584121 commented on GitHub (Oct 24, 2025): @mdrxy Thanks for your reminder, here is the [update](https://github.com/langchain-ai/langchain-milvus/pull/101)

yindo commented

2026-02-16 06:15:50 -05:00

@mdrxy commented on GitHub (Oct 27, 2025):

@zc277584121 thank you! Will get docs up here today

@mdrxy commented on GitHub (Oct 27, 2025): @zc277584121 thank you! Will get docs up [here](https://reference.langchain.com/python/integrations/langchain_milvus/) today

yindo referenced this issue

2026-02-16 06:15:57 -05:00

[PR #25] [MERGED] release 0.1.7 #53

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: langchain-ai/langchain-milvus#25