Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it possible to switch the documentation theme? #1610

Closed
baseplate-admin opened this issue Oct 6, 2023 · 2 comments · Fixed by #1614
Closed

Is it possible to switch the documentation theme? #1610

baseplate-admin opened this issue Oct 6, 2023 · 2 comments · Fixed by #1614

Comments

@baseplate-admin
Copy link

baseplate-admin commented Oct 6, 2023

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
Copy link
Owner

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 added a commit to jnns/django-filter that referenced this issue Oct 16, 2023
Add 'furo' dependency to a new documentation-specific requirements.txt
to have it available during the build process on ReadTheDocs
and configure Sphinx to use it.

Configuration directives for the sphinx-rtd theme are no longer required.

Closes carltongibson#1610
@jnns jnns mentioned this issue Oct 16, 2023
@jnns
Copy link
Contributor

jnns commented Oct 16, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants