Skip to content

Code snippets in docstrings not rendered properly #12

@and3rson

Description

@and3rson

I have the following stub:

---@param r integer
---@param g integer
---@param b integer
---@return integer
---Returns 16-bit color
---
---For example, ``display.color565(255, 0, 0)`` returns 63488.
---
---Example:
---```lua
---local color = display.color565(255, 0, 0)
---display.draw_line(0, 0, 100, 100, color)
---```
function display.color565(r, g, b) end

When rendered with lua_ls, the code snippet looks good:

зображення

However, in Sphinx the example code is not showing properly (due to being markdown):

зображення

I tried changing it to use Sphinx directives in the docstring, like so:

---@param r integer
---@param g integer
---@param b integer
---@return integer
---Returns 16-bit color
---
---For example, ``display.color565(255, 0, 0)`` returns 63488.
---
---Example:
---.. code-block: lua
---
---    local color = display.color565(255, 0, 0)
---    display.draw_line(0, 0, 100, 100, color)

However, it just renders the entire thing verbatim:

зображення

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions