symfony-tools/docs-builder

Unsupported "strong" directive

javiereguiluz opened this issue · 3 comments

javiereguiluz commented

This file https://github.com/liip/LiipImagineBundle/blob/2.x/Resources/doc/filters/general.rst uses :strong: to make text bold:

Background Options
~~~~~~~~~~~~~~~~~~

:strong:`color:` ``string``
    Sets the background color HEX value. The default color is white (``#fff``).

:strong:`size:` ``int[]``
    Sets the generated background size as an integer array containing the dimensions
    as width and height values.

Sphinx supports it:

image

But docs-builder doesn't:

image

Question: should we implement this?

My opinion: if it's not too complicated, yes. Otherwise, "won't fix".

wouterj commented

The :strong: role is equal to **...**. I guess it's quite easy to implement the role, but I would also vote to use **color** in the LiipImagineBundle docs.

javiereguiluz commented

Yes, this could be a team-effort: ask Symfony bundles to please use @OskarStark's "DOCtor RST" for their docs ... and implement some rule in DOCtor to suggest using ** instead of :strong: (same for other things that we might find).

javiereguiluz commented

Closing as "won't fix".

The LiipImagineBundle contents are being fixed in liip/LiipImagineBundle#1361 and I've opened an issue in DOCtor-RST: OskarStark/doctor-rst#931

  • 👍1