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

No descriptions formatting #36

Closed rbcasperson closed 4 years ago

rbcasperson commented 4 years ago

Screen Shot 2020-05-04 at 4 57 28 PM

^ That. Gimme now please!

Commit messages have more specific context, but basically I want to be able to treat my feature and scenario descriptions as raw rST so that I can get that rst goodness for specific feature and scenarios.

I am open to suggestions on the flag name --raw-descriptions.

rbcasperson commented 4 years ago

Yeah it's an interesting thought. It's tricky because this is a pre-processing option as opposed to a post-processing option like the tag url stuff.

I think that if you wanted to use this flag for some features, but not for others, you could run sphinx-gherkindoc multiple times and still combine the generated rst files together with sphinx-build.

Honestly, I think that this should probably be the default, but I didn't want to break current behavior. I'm not sure there's a good reason to format descriptions at all. So maybe we can come to that conclusion, but at least want to start with the ability to turn it on without any risk to default behavior.

dgou commented 4 years ago

Turning this in to the default isn't something I'm eager to do. I did do a test run at work without the flag and everything built as before.