Skip to content

automatic links for API function names (to api ref) #910

@jorgeorpinel

Description

@jorgeorpinel

Similar to how we automatically link dvc <command> to their cmd ref in the docs, the following quoted strings (can be pulled from sidebar.json) should link to the corresponding API reference page: dvc.api.get_url(), dvc.api.open(), dvc.api.read(), and dvc.api.summon().

UPDATE: Another one could be dvc.api -> /doc/api-reference (also get from sidebar.json)

This way we can easily start mentioning these functions from everywhere in the docs, and have the users be able to jump to the API ref.

  • And replace any manual links to these introduced with api: create docs #908 or any other PR before this is implemented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A: websiteArea: websitetype: enhancementSomething is not clear, small updates, improvement suggestionswebsite: eng-docDEPRECATED JS engine for /doc

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions