RunestoneComponents icon indicating copy to clipboard operation
RunestoneComponents copied to clipboard

Sphinx extension metadata

Open bjones1 opened this issue 5 years ago • 2 comments

Curerntly, our Runestone Components don't return any extension metadata. We should do this! We could probably define a standard value to return for all Runestone Components, then just return that.

bjones1 avatar Sep 09 '20 21:09 bjones1

Can you say some more? I looked at the page briefly but I'm not getting what problem this would solve...

bnmnetp avatar Sep 09 '20 22:09 bnmnetp

I can see several minor advantages:

  • Specify a version, which we already have, in case anyone uses our components in some larger project.
  • Specify an env_version, and increment this anytime we change what we store in env. This helps avoid confusion -- it will auto-rebuild the book when the env_version changes, instead of getting issues with crashes/confused builds.
  • Specify parallel_read_safe as True. This might improve build performance a bit.

All this can go as a constant in runestonedirective.py, then each setup function returns this constant.

So, nothing critical, but an easy addition with some nice side benefits.

bjones1 avatar Sep 10 '20 03:09 bjones1