Feedback request: Updated API reference

[baskaryan]

We've been working on a revamp of our python api reference and would love to get your feedback on our first pass at it: https://python.langchain.com/v0.2/api_reference/reference.html

Things we'd love to know:

• do you like these more than the existing api reference docs (react 👍 👎),
• what do you find difficult / unintuitive about navigating the updated reference,
• where specifically is it better/worse than the existing reference,
• any other feedback.

Note, we've moved the new API reference into the main docs site. To not break everyones existing reference links and suddenly force everyone to adjust to a new docs structure, we'll be continuing to maintain and host the existing format of the api reference at https://api.python.langchain.com/. That is, hopefully this update will be minimally disruptive and folks can switch to the new api reference if/when they're ready.

[lfenzo]

In general, this is a very positive move from what we had before in terms of API docs. A centralized API reference helps to create cohesion around the components in the ecosystem as most of them are shipped as standalone packages. My feeling is that having this centralized source of docs makes it easier to grasp how they relate to each other.

A couple of thoughts:

• Left side panel seems broken in mobile devices, once expanded the panel takes up only ~20% of the screen. Text gets squeezed in the available space making it very difficult to read and navigate; probably some minor setting to be tweaked in the docs theme. Tested with Chrome on Android.
• Not all classes have the "base class" field in each doc page. Since this is a sphinx setting I'm assuming that the absence of these base classes is just a matter of missing information in the docstrings, but still worth mentioning.
• Not sure if this is done manually, but in pages like llms it would be nice to have references to the classes in "Class hierarchy" and "Main helpers".
• The table format used to show methods and classes is very legible. I wish other doc pages used the same format to show multiple entries in such condensed manner.
• Having expandable items in the side panel makes it easier to visualize the overall organization of components, specially in the langchain community tab.

[baskaryan]

Thanks for the thoughtful feedback!!

• Yep will fix
• This may have to do with pydantic versus non-pydantic classes, their docs are generated slightly differently. Will take a look
• 👍
• Agree! i believe non-pydantic classes have the sort of table you're talking about. with pydantic not sure how easy it is to do this atm. we're using autodoc-pydantic for now to generate docs but will likely move off it at some pt, at which pt we can/should definitely add tables for methods/attributes

[IP050]

Better for my eyes for sure!

I think the deprecation notice could use some work

I'd prefer to see them underlined and clickable or/and strip them of any stuff like: Use new agent constructor methods. I'd say either list more, less because etc. adds nothing.

[baskaryan]

Appreciate the feedback! Yea linking would be great, will look into it. That particular deprecation seems to be set incorrectly, will update!

[IP050]

Yeah I figured that'd be the case and it's obviously nitpicking an extreme example. Since I am nitpicking some linked examples using {x} link to a 404 doc page, might be more but these should be easy to monitor/catch:
Examples using create_csv_agent
Examples using create_spark_dataframe_agent
Examples using create_xorbits_agent

[baskaryan]

updating example links #25589