Skip to content

planemo lint false positive warning about HelpInvalidRST when using local images? #1589

@kostrykin

Description

@kostrykin

In this tool wrapper XML we have the following block of RST code within the help tag:

.. image:: he.png
  :width: 434px
  :scale: 50%

Doing a planemo lint gives a warning:

.. WARNING (HelpInvalidRST): Invalid reStructuredText found in help - [:: (WARNING/2) Problem reading image file: [Errno 2] No such file or directory: 'he.png'
].

However, the RST code is in accordance with the best practices https://galaxyproject.org/defining-images-in-tool-configs:

The previously required $PATH_TO_IMAGES is now deprecated, and is ignored if used. The "best practice" for including image files within the repository is to place them in the directory path /static/images within the repository hierarchy in the tool shed.

.. image:: <some image file name>

It also works when served on Galaxy Europe:

https://usegalaxy.eu/root?tool_id=toolshed.g2.bx.psu.edu/repos/imgteam/color_deconvolution/ip_color_deconvolution/0.9+galaxy0

So is this a false positive warning?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions