Using different theme for survey results

writethedocs / www

The main website for Write the Docs.

http://www.writethedocs.org

Other

1.32k stars 511 forks source link

Using different theme for survey results #2102

Open goatlady opened 7 months ago

goatlady commented 7 months ago

Would it be possible to apply a separate Sphinx theme such as Furo just to the salary survey results? Essentially making the results page a sub-site that breaks out of the regular site theme with it's own navigation?

This would enable:

wider content area (800px on largest screens, vs 660px)
sans-serif font with regular modern numerals instead of old-style, much better for tabular data
fixed navigation bar to allow readers to jump back and forward through sections without having to scroll back to the top - I think it would even be good for usability to break the results up into separate pages (especially if it's possible to mix internal anchor nav with separate page nav in the sidebar)

I can tweak the CSS also to better fit WTD branding, but I don't think a lot would be required because it's pretty plain.

plaindocs commented 7 months ago

It turns out you can't use multiple themes within the same doc set.

Because the survey is relatively static, we could look at publishing it separately and copying it over, but it's not super convenient.

Tagging in @ericholscher and @mxsasha in case they have better ideas.

plaindocs commented 7 months ago

We could just host it at survey.writethedocs.org or something entirely separately as a separate docs set?

ericholscher commented 7 months ago

Yea, I'd put it on another RTD project probably. There's a couple options we have, but feels like a decent bit of overhead for some smallish style tweaks. We could look at making changes to the main WTD site, which could also use a refresh at some point 🤷

goatlady commented 7 months ago

The things I'm looking to do are usability improvements rather than style tweaks - but I'm looking now at how the conference sub-sites work with custom templates, that might be more easily achievable.

mxsasha commented 7 months ago

Hmm, my first thought is also to run it as a separate site, because it sounds like the lowest complexity solution. The conference setup has its own templates indeed, but that's also quite fragile from time to time.

(once I figured out how the conference templates work, I realized it was a lot less complicated than I initially thought)

goatlady commented 7 months ago

I've got a very basic custom template working locally and it seems fine so far - the results report is much less complex than the conference sites, so maybe the fragility is less of an issue? I'll make a PR with my branch and you folks can take a look.