Skip to content

[Doc]: Documentation source code hyperlinks do not always point to the correct source code #17120

@cartesian-plane

Description

@cartesian-plane

📚 The doc issue

For example, the documenation of the generate method in LLM Class.
Clicking its source button, we find that it points to an unrelated function in utils.

This is just one example, a similar thing happens with the link for LLM.encode.

Suggest a potential alternative/fix

I am not familiar with the way Sphinx generates documentation, but there may be something to be done in one of its configs.

Before submitting a new issue...

  • Make sure you already searched for relevant issues, and asked the chatbot living at the bottom right corner of the documentation page, which can answer lots of frequently asked questions.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions