search

carltongibson / django-filter

A generic system for filtering Django QuerySets based on user selections
https://django-filter.readthedocs.io/en/main/
Other
4.45k stars 766 forks source link

Is it possible to switch the documentation theme? #1610

Closed baseplate-admin closed 12 months ago

baseplate-admin commented 1 year ago

Hi,

Thanks for creating this awesome package. I am a big fan of this project ( been using it in production for half a year )

Now, I was wondering if it was possible to switch to a better documentation theme?

Since we are using Sphinx, Maybe furo is a good candidate?

Thanks a bunch :D

Some of projects that uses furo:

carltongibson commented 1 year ago

Hi yes! 🙌

Thanks i'd be really happy to accept this.

Something changed in RTD recently and the old theme, which was OK, stopped working, so getting Furo going would be perfect!

Thanks for the input! 🎁

jnns commented 12 months ago

Hello Carlton, hello @baseplate-admin,

I took a stab at changing the docs template to Furo. It seems to have built just fine on https://django-filter-furo.readthedocs.io/. Feel free to check it out.

As it can be confusing to also have outdated documentation available under https://dwbf.readthedocs.io/ and https://rpkilby.github.io/django-filter/, it's very nice if the canonical documentation stands out with a modern theme.

I will remove the Furo documentation variant from ReadTheDocs once this issue is closed.