sphinx theme CLI

[abitrolly]

I just ponder if people here will find a tool that can help discover and debug various theme options from existing config easier. I've personally spent a lot of days trying to find where to patch code for misbehaving features, and with inheritance and themes being in another packages it is quite a challenge.

sphinx theme

RTD (inherited from **basic** which inherited from **none**)
RTD options
    option1=True (default)   -- sets bla bla bla
    option2=True             -- sets xyz xyz xyz
basic inherited options:
    optionxxx = False (overridden default)   -- bla bla bla docs
    optionyyy = False (default)  -- bla bla bla read me
    optionzzz = False            -- bla bla bla whatever

This could also come with a table view, but the basic idea is that. Would it be useful for you as much as for me? Maybe a better view?

[timhoffm]

Personally, I would have much use for such a tool. I'm looking for theme options and their description in the respective theme HTML docs. Options are typically grouped/named in conf.py so that the effective theme-specific configuration is reasonably discoverable. Convention should be good enough here and we don't need tooling.

[abitrolly]

@timhoffm unfortunately, inherited options like navigation_with_keys are not included in sample conf.py or theme docs. I agree that conventions would be nice, but the Spinx project that can set these conventions doesn't seem to be active #14404

[timhoffm]

Yes, the core maintainers are unfortunately not that active currently.

But also for the suggested sphinx theme CLI, substantial lifting would have to be done on the sphinx side.