Open mirekdlugosz opened 3 years ago
@mirekdlugosz: Many thanks for submitting this issue. I just realized that Graphviz is a supported tag, even though it's not mentioned in the README, and then I came across this issue pointing out the general tag documentation disconnect.
I agree that it would be preferable to have the documentation up-to-date and available in single-source-of-truth form. Would anyone like to help out by starting the documentation process? I suggest we use a combination of Sphinx + MyST + Furo (latter is a modern Sphinx theme that supports and recommends MyST).
What do you think? (cc: @dorneanu @Xion @rlaboiss)
Right now, in-tree tags documentation is duplicated in Readme.md and each tag source file docstring. As is usually a case for duplicated content, of course it has diverged over time
YOUTUBE_THUMB_ONLY
andYOUTUBE_THUMB_SIZE
variables)This issue can be closed when we have single source of truth for all tags documentation, and that documentation is up to date.
Personally I would explore generating all docs from docstrings using sphinx, and creating readthedocs account to store that, but I am open to other solutions, too.