lablup / lablup/backend.ai

Custom multi-target code blocks in the documentation

Open
#1,798 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
670
Forks
183
Avg merge
17h 7m
Merged PRs (30d)
358

Description

Like the following example, let's add a custom code-block renderer to display the example codes in multiple target contexts.

We could also consider the MSDN style, but in our case, individual code blocks may or may not have the full multi-target contents unlike the .NET manual.

For instance, the Client SDK's functional API examples may be presented as:

- Synchronous version (based on `ai.backend.client.session.Session`)\* Some APIs are provided as the async version only.

- Asynchronous version (based on `ai.backend.client.session.AsyncSession`)
- Raw HTTP traces (#1799)

JIRA Issue: BA-167

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.