Request: More easily enable other builders to implement support for the strike role

[adamtheturtle]

Right now there is a fallback if the builder is not a supported builder.
Would you be open to a PR which removes that fallback, so that by default another builder gets an error?

[SilverRainZ]

Hi, what error do you get?
I added this fallback to prevent the strike nodes from breaking unsupported builders. If your builder wants to implement the node visitor instead of using the fallback, you can try what confluencebuilder does: https://github.com/sphinx-contrib/confluencebuilder/blob/61287ff7eaf0d7a79b3d677b2a532be9ce96a080/sphinxcontrib/confluencebuilder/storage/translator.py#L3311

[adamtheturtle]

I'm currently doing something different to confluence builder, where I loop through the children of an element and create an object based on the child class:

            new_text = text(
                text=child.astext(),
                bold=isinstance(child, nodes.strong),
                italic=isinstance(child, nodes.emphasis),
                code=isinstance(child, nodes.literal),
                strikethrough=isinstance(child, strike_node),
            )

I added this fallback to prevent the strike nodes from breaking unsupported builders

Is that normal in Sphinx extensions? My expectation would be that if there is an unsupported node type like :strike:, there is an error rather than it invisibly looking like normal text.

[SilverRainZ]

Is that normal in Sphinx extensions?

I think no, it is my personal idea. If a user uses HTML builder and any other unsupported builder at the same time, using the strike extension will break the latter one, and I can do sth for that, so I add the fallback.

I can export a public supported_builders list, then you can add your builder to it. What do you think?

# Global
supported_builders = [StandaloneHTMLBuilder, LaTeXBuilder]

...
    global supported_builders
    if not isinstance(env.app.builder, supported_builders):
        # Builder is not supported, fallback to text.
        return [Text(unescape(text))], []

[adamtheturtle]

That would work well for me, thank you.

[SilverRainZ]

You can try branch of #8, use make dist to build a wheel package.

[adamtheturtle]

Great to see this closed @SilverRainZ and looking forward to the next release.

[SilverRainZ]

Great to see this closed @SilverRainZ and looking forward to the next release.

You can try version 1.3a1

[adamtheturtle]

1.3a1 works great for me, thank you.