Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
1 task
jorgeorpinel opened this issue Jan 9, 2020 · 0 comments · Fixed by #1305
Closed
1 task

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

jorgeorpinel opened this issue Jan 9, 2020 · 0 comments · Fixed by #1305
Labels
A: website Area: website type: enhancement Something is not clear, small updates, improvement suggestions website: eng-doc DEPRECATED JS engine for /doc

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jan 9, 2020 •
edited
Loading

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.
@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions website: eng-doc DEPRECATED JS engine for /doc api labels Jan 9, 2020
@jorgeorpinel jorgeorpinel changed the title web: automatic links for API function names in md quotes app: automatic links for API function names in md quotes Jan 9, 2020
@jorgeorpinel jorgeorpinel changed the title app: automatic links for API function names in md quotes app: automatic links for API function names in md Jan 9, 2020
@shcheklein shcheklein added the A: docs Area: user documentation (gatsby-theme-iterative) label Jan 9, 2020
@weekly-digest weekly-digest bot mentioned this issue Jan 12, 2020
Closed
@jorgeorpinel jorgeorpinel mentioned this issue Jan 13, 2020
Closed
2 tasks
@jorgeorpinel jorgeorpinel removed the A: docs Area: user documentation (gatsby-theme-iterative) label Jan 18, 2020
@jorgeorpinel jorgeorpinel changed the title app: automatic links for API function names in md link: automatic links for API function names (to api ref) in md Jan 19, 2020
@shcheklein shcheklein mentioned this issue Apr 9, 2020
Closed
3 tasks
@shcheklein shcheklein changed the title link: automatic links for API function names (to api ref) in md automatic links for API function names (to api ref) Apr 9, 2020
@shcheklein shcheklein added the A: website Area: website label Apr 9, 2020
@mvshmakov mvshmakov mentioned this issue May 18, 2020
Merged
shcheklein pushed a commit that referenced this issue May 19, 2020
@mvshmakov
docs: API auto-mentioning in docs (#910) (#1305)
24d7385 
* docs: api markdown code linker

* docs: api and command markdown code tests

* docs: manual links to api method pages removed

* docs: codeclimate fixes

* docs: test fixes

* docs-910: helpers refactoring

* docs-910: bringing back formatting

* docs-910: indent fix and redundant url removal
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A: website Area: website type: enhancement Something is not clear, small updates, improvement suggestions website: eng-doc DEPRECATED JS engine for /doc
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: API auto-mentioning in docs (#910) mvshmakov/dvc.org
2 participants
@jorgeorpinel @shcheklein