django-htmx Now on Read the Docs

2022-03-02 Artist’s impression of my writing desk.

I’ve just released django-htmx 1.9.0. As part of this release, it now has a documentation site built with Sphinx, hosted on Read the Docs at django-htmx.readthedocs.io.

The documentation looks a lot nicer than what can be fit in the GitHub README, especially thanks to the Furo theme. It’s also more digestible on several pages.

I’ve also added a few sections, covering some useful tips for using htmx with Django:

How to add htmx to your Django project. django-htmx does not include htmx, so you can upgrade the two separately.

I covered how to download htmx into your project’s static files. This goes with my open PR to htmx to de-emphasize using unpkg.com directly.
How to make htmx pass Django’s CSRF token. This is a commonly required pattern. It was previously covered only in the included “example project”, but that was not so easy to discover.
How to do partial rendering. This is a neat trick for cutting down server side render times a bit. This techinque is also covered in the example project.

The “tips” page may expand in the future with further techniques.

Thanks to:

Ben Beecher for doing initial Sphinx and Read the Docs setup in PR #194.
Pradyun Gedam for the Furo theme.
The Read the Docs team for providing such great documentation hosting!

—Adam

Learn how to make your tests run quickly in my book Speed Up Your Django Tests.

One summary email a week, no spam, I pinky promise.

Related posts:

Tags: django