openrewrite / rewrite-recipe-markdown-generator

Utility that generates OpenRewrite recipe documentation in markdown format for all recipes on the classpath.
Apache License 2.0
2 stars 7 forks source link

Do not show Maven and Gradle steps to running Python recipes for now #105

Closed timtebeek closed 3 months ago

timtebeek commented 3 months ago

Right now the docs for Python recipes also show Maven and Gradle tabs https://docs.openrewrite.org/recipes/python/changemethodname

image

In reality these recipes can only be run through the Moderne CLI for now, as we took out the parser a while ago.

We should update the doc generator to take out those run instructions for Maven and Gradle, and only keep the Moderne CLI as an option.

timtebeek commented 3 months ago

/cc @mike-solomon

okundzich commented 3 months ago

I don't think we should be publishing anything for python at the moment. more work is needed (please remove)

mike-solomon commented 3 months ago

Removed Python from the generated docs here: https://github.com/openrewrite/rewrite-recipe-markdown-generator/commit/b231676a511ed6446a2706fe48e1bf6b03f779da

I'm fine keeping this issue around for if/when we add it back for context. Feel free to close if you'd like, though @timtebeek .

timtebeek commented 3 months ago

Thanks for those quick changes! I'm fine keeping this issue closed. We can always revisit in the future, and would be quick enough to realize that this change is then necessary.