sphinx-extensions icon indicating copy to clipboard operation
sphinx-extensions copied to clipboard

Expand extension's page with "nice to know" settings

Open humitos opened this issue 5 years ago • 0 comments

I think it could be useful to have a section (or a subpage) on each extension's page that mention extra settings that the extension has and could be useful for the reader (see #6).

For example, in sphinx-hoverxref maybe worth to mention hoverxref_auto_ref as well.

I'm not sure to have clear how this would look like, but it may be interesting to have a quick look of recommended configs. Although, I don't want to overload the pages and kill the small amount of configuration steps.

  • nbsphinx:
    • https://github.com/humitos/sphinx-extensions/pull/4#issuecomment-610568306

humitos avatar Apr 07 '20 19:04 humitos