Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create single source of truth for in-tree tags documentation #7

Open
mirekdlugosz opened this issue Feb 8, 2021 · 1 comment
Open
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@mirekdlugosz
Copy link
Collaborator

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

  • There are 18 or 19 tags in tree (depending if you count "generic" as real tag), but 13 listed in Readme. Which means that 5 tags are hard to discover and require reading source file to understand how they work
  • docstrings often do better work at documentation, by providing more examples and example HTML output
  • sometimes Readme provides better documentation, like in youtube tag (where Readme explains YOUTUBE_THUMB_ONLY and YOUTUBE_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.

@mirekdlugosz mirekdlugosz added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Feb 8, 2021
@justinmayer
Copy link
Contributor

@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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants