langchain-ai/langchain-datastax
1
0
Fork 0
mirror of https://github.com/langchain-ai/langchain-datastax.git synced 2026-07-19 23:04:52 -04:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

Updating reference docs for new site #30

New Issue
Open
opened 2026-02-15 18:15:26 -05:00 by yindo · 5 comments
yindo commented 2026-02-15 18:15:26 -05:00
Owner
Copy Link
Copy Source

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_astradb/

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-datastax 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_astradb/ 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-datastax` 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 commented 2026-02-15 18:15:27 -05:00
Author
Owner
Copy Link
Copy Source

@hemidactylus commented on GitHub (Oct 15, 2025):

@mdrxy Thank you for the heads-up!
On your last point, shouldn't the syntax be [Runtime](langgraph.runtime.Runtime) ? (i.e. square-then-round bracket pairs).

Probably a trivial question, but for all I know there may be some dialect in use I'm not aware of.

@hemidactylus commented on GitHub (Oct 15, 2025): @mdrxy Thank you for the heads-up! On your last point, shouldn't the syntax be `[Runtime](langgraph.runtime.Runtime)` ? (i.e. square-then-round bracket pairs). Probably a trivial question, but for all I know there may be some dialect in use I'm not aware of.
yindo commented 2026-02-15 18:15:27 -05:00
Author
Owner
Copy Link
Copy Source

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

@hemidactylus I think that's right - thanks!

@mdrxy commented on GitHub (Oct 15, 2025): @hemidactylus I think that's right - thanks!
yindo commented 2026-02-15 18:15:27 -05:00
Author
Owner
Copy Link
Copy Source

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

@hemidactylus some more findings from MkDocs/mkdocstrings

[]()

is used when you have a ref in the same module/page

[][]

is for different modules/pages

@mdrxy commented on GitHub (Oct 15, 2025): @hemidactylus some more findings from MkDocs/mkdocstrings ```txt []() ``` is used when you have a ref in the same module/page ```txt [][] ``` is for different modules/pages
yindo commented 2026-02-15 18:15:27 -05:00
Author
Owner
Copy Link
Copy Source

@sl-at-ibm commented on GitHub (Oct 16, 2025):

Awesome, thanks! The fix is coming in the next PR then :)

@sl-at-ibm commented on GitHub (Oct 16, 2025): Awesome, thanks! The fix is coming in the next PR then :)
yindo commented 2026-02-15 18:15:28 -05:00
Author
Owner
Copy Link
Copy Source

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

I've added some more guidelines here https://github.com/langchain-ai/docs/blob/main/reference/python/README.md#mkdocsmkdocstrings-python-cross-reference-linking-syntax

@mdrxy commented on GitHub (Oct 16, 2025): I've added some more guidelines here https://github.com/langchain-ai/docs/blob/main/reference/python/README.md#mkdocsmkdocstrings-python-cross-reference-linking-syntax
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
pull-request
Mirrored from GitHub Pull Request
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langchain-datastax#30
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?