search

wpilibsuite / sphinxext-opengraph

Sphinx extension to generate unique OpenGraph metadata
https://sphinxext-opengraph.readthedocs.io
Other
74 stars 27 forks source link

Rewrite and Refractor #20

Closed ItayZiv closed 3 years ago

ItayZiv commented 4 years ago

Part of https://github.com/wpilibsuite/sphinxext-opengraph/issues/11. TODOs can be ignored (will be removed).

TheTripleV commented 4 years ago

Regarding list handling: All I care about is that index pages (that only have lists) have lists formatted.

The one edge case I can think of that needs to be clarified: https://docs.wpilib.org/en/latest/docs/getting-started/getting-started-frc-control-system/radio-programming.html

It's a list in the first section of text.

ItayZiv commented 4 years ago

My thought is to go back to a more similar impl to what was before, just actually format lists in. This is, numbered lists are treated like a normal list, sublists have a bit of special formatting, the rest is just comma-separated elements. It might be worth ignoring sections with only lists, but not sure if that's something that should be dealt with...

TheTripleV commented 4 years ago

I don't really have a strong opinion on lists other than the point about index pages I made above. As long as that works, do what you think is best.