Document usage

[pradyunsg]

Is this theme usable by simply adding html_theme = "insegel" to the conf.py for a Sphinx project?

[autophagy]

Hi @pradyunsg - sorry for the late reply!

You first have to install the package via pip, usually by pip install insegel or by adding insegel to your projects requirements.txt or setup.py file (however you're managing documentation dependencies.

Then, yes, just adding the html_theme string to conf.py should work.

[pradyunsg]

Thanks for the response (and happy new year)!

I figured it out and added the theme on sphinx-themes.org (let me know if you don't want it there). Beyond that, it'd be nice to have this information in the README, but that's upto you. :)

[autophagy]

Good point! I'll add the info to the readme. 👍