JOJ0 / synadm

Command line admin tool for Synapse (the Matrix reference homeserver)
https://synadm.readthedocs.io
GNU General Public License v3.0
186 stars 25 forks source link

Modernize the look of our generated docs #156

Closed JOJ0 closed 3 weeks ago

JOJ0 commented 1 month ago

The readthedocs theme we are using, in my opinion, looks and feels outdated. I'm currently reading a lot of data science and machine learning related documentation. The PyData theme for Sphinx seems to be very popular and I have to admit that I like it very much. Have a look at these random docs links which use that theme :

BTW I also would have experience in implementing the PyData theme, since I did it for the Beets project already (https://beets.rtfd.io).

Nevertheless I'd like to start a discussion on what theme would be best for the synadm project. Some more suggestions I like are:

Here's an overview of (all?) available Sphinx themes - but be aware of that not every theme has the same features when it comes to usability: https://sphinx-themes.org/