A clean, modern, customisable, searchable, mobile-friendly theme for documentation.
This theme is still under development. Things will change without notice! :)
sphinx-theme-builder
, Tailwind, webpack
, and more).To use the theme in your existing Sphinx documentation:
Install Lutra in documentation's build environment.
$ pip install lutra
Update the html_theme
in conf.py
. If there's any configuration variables that start with html_
in this file, comment them out.
html_theme = "lutra"
Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉
For more information, visit Lutra's documentation.
Lutra is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at our Contributing Guide for more information.
Lutra draws inspiration from some excellent technical documentation websites:
We use BrowserStack to test on real devices and browsers. Shoutout to them for supporting OSS projects!
I plucked this out of the scientific name for The Eurasian otter: Lutra lutra. You can decide whether I picked the first one or the second one.
No one yet!
This project is licensed under the MIT License.