search

jolly-good-toolbelt / sphinx_gherkindoc

A tool to convert Gherkin into Sphinx documentation
https://jolly-good-toolbelt.github.io/sphinx_gherkindoc/
11 stars 10 forks source link

Fix step text format bug #25

Closed rbcasperson closed 4 years ago

rbcasperson commented 4 years ago

This is because sphinx-gherkindoc already formats this text into a code block. That is plenty sufficient, and rST doesn't support nested formatting.

Thanks to @dgou for finding the bug. It makes me think that visual regression tests for this tool would be very very useful since looking at the rst lists of strings with newlines in them isn't exactly ideal for seeing how it affects the tool. Or at least get the link to the built docs added to a PR as a comment.

Here's how it looks in the built docs after this change:

Screen Shot 2020-02-10 at 10 33 29 AM
dgou commented 4 years ago

I think getting the link to the built docs might be a simpler first step? Not against the visual regression, but it feels like it would bring in a lot more changes and tooling.