Confusion about how an HTML backend should be implemented

[mitchellwrosen]

Hi all,

The README claims an HTML backend is trivial to implement:

And the main library documentation suggests you might start the conversion from a SimpleDocTree:

However, the SimpleDocTree documentation suggests it's not suitable for rendering to HTML:

Perhaps the diagram in the second screenshot is a bit out of date? Thanks!

[Lev135]

However, the SimpleDocTree documentation suggests it's not suitable for rendering to HTML

It seems that you've misread the documentation: here just said that SimpleDocStream is not suitable for rendering HTML and you should use SimpleDocTree.

[georgefst]

For what it's worth, I have actually implemented an HTML backend, though I haven't actually used it extensively or recently.

[mitchellwrosen]

@Lev135 Ah, thanks! Yes, I did misread the docs. It's confusing for the reader to begin the documentation for SimpleDocTree with "A SimpleDocStream ..." :sweat_smile: