Thanks for doing this! I read through all the comments. Couple of points:
- With 22 respondents and large standard deviation, the numbers don't really mean anything. Basically all themes are rated the same. - The written comments are most useful and I get the impression that almost any of the themes could work, but each requires some tweaking to fit for SymPy. I would recommend choosing based on which theme has the most configuration options and energy behind it because we want to easily tweak things and we automatically benefit from upstream improvements. If we do pydata, we join with our counterparts Numpy, scipy, pandas, etc. and it keeps us connected nicely to that community and when people jump around the scipy ecosystem docs they get the same (or similar) experience. RTD theme, by far, is the most used because it is the default theme on their service and there is a company that spends a lot of dev time on it. RTD is quite valuable and gives a uniform experience across a large set of python projects. Furo and book are likely used the least and have the smallest dev communities. Furo, as I understand, is essentially a one man show. It looks nice now, but may not be a good long term solution. Jermey and Aaron concluded that Furo was the best choice, but I hope these other aspects are considered too. We're a big project and even if Furo currently has the best looking design of the four, there are other non-design factors that are also quite important and, IMO, outweigh the 0.1 point rating differences in the comparison of the designs. Jason moorepants.info +01 530-601-9791 On Sat, Feb 26, 2022 at 1:24 AM Jeremy Monat <[email protected]> wrote: > Hello SymPy community, > > SymPy ran a user survey about its documentation theme from February 5-19, > 2022. The primary purpose of the survey was to guide the selection of a > Sphinx theme for the SymPy Documentation at https://docs.sympy.org. We > thank everyone who took and shared the survey. > Even though the survey is no longer open, we still welcome feedback on > SymPy's documentation. Feel free to reach out to us on the mailing list, or > in the Github issue to change the Sphinx theme > <https://github.com/sympy/sympy/issues/22716>. > > I have written up an analysis of the results at > https://www.sympy.org/sympy-docs-survey/2022-theme-survey.html (thanks to > Aaron Meurer for some analysis code, and posting the analysis there). The > source code for the > Jupyter notebook can be found at > https://github.com/sympy/sympy-docs-survey. I > have included a summary of this analysis here. > > A total of 22 people responded. The survey was done on Google Surveys and > was shared on the SymPy public mailing list, the @SymPy > <https://twitter.com/SymPy> Twitter account, and a SymPy discussion on > GitHub <https://github.com/sympy/sympy/discussions/23055>. The survey > consisted of 14 questions, all of which were optional. The results of these > responses are summarized here. We would like to thank everyone who took and > shared the survey. > > At a high level, there are three main takeaways from the results. > > 1. > > The themes can be divided into three ratings categories, where the > rating scale was 1 (Not very useful) to 4 (Very useful): > 1. Highest: Furo <https://bertiewooster.github.io/sympy-doc/furo> at > 2.95. > 2. Middle: PyData <https://bertiewooster.github.io/sympy-doc/pydata> > and Book <https://bertiewooster.github.io/sympy-doc/book>, nearly > tied at 2.85 and 2.86, respectively. > 3. Lowest: Read the Docs (RTD) > <https://bertiewooster.github.io/sympy-doc/rtd> at 2.47. > 2. > > Most comments about themes, both likes and dislikes, were about > formatting, look and feel, and navigation. > 3. > > We should proceed with the Furo theme, customizing it to address > respondents' dislikes about its formatting. We can keep the PyData and Book > themes in mind as backup options. > > Again, I would like to thank everyone who took the time to fill out this > survey. It really helps us to have your feedback. > > Jeremy Monat > > -- > You received this message because you are subscribed to the Google Groups > "sympy" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/sympy/ae6935a1-d638-4265-a094-bd59f1dfc643n%40googlegroups.com > <https://groups.google.com/d/msgid/sympy/ae6935a1-d638-4265-a094-bd59f1dfc643n%40googlegroups.com?utm_medium=email&utm_source=footer> > . > -- You received this message because you are subscribed to the Google Groups "sympy" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAP7f1Aidk%3DK_hNciDukWPUM4V6hUNxZXDMkQm-%3DMnR5WcnNspA%40mail.gmail.com.
