jbms / sphinx-immaterial

Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system
https://jbms.github.io/sphinx-immaterial/
Other
177 stars 28 forks source link

Extends docs with hint when migrating #239

Closed funkyfuture closed 1 year ago

funkyfuture commented 1 year ago

as mentioned in #238, here's a little docs extension for people who are switching from another theme. i made it collapsed by default as it could potentially grow. for now i'm setting my migration more or less aside, so that's all as first impression.

on that occasion, i think the docs could really benefit from a section for hackers. i noticed inconsistencies how admonitions are parsed and it took me a while to get a grip how i should set up a test for that. admittedly i'm not in best condition atm and then dealing with docutils is just too much of a pita.