Open pydanny opened 11 months ago
No experience with the Jupyter doc-stack (which seems very data-eng centric), but a +1 for Mkdocs because
If it's for docs as code, definitely be my choice. Other cases, ymmv.
MkDocs has plugins to integrate and render ipynb
files too :)
In my opinion mkdocs is very easy and interesting to work with. It has many plugins to make the documentation looks nice and informative like git-revision plugin that automatically show when the documentation is first published and when it was updated.
Up for discussion is which of my two options I want to use, which needs to be Python to make it possible to plug in code generation:
Jupyter Book is Sphinx+Myst+
.ipynb
files.ipynb
files!Mkdocs for Material is what FastAPI and pydantic use
.ipynb
files with mkdocs extension (Suggested by @pawamoy)Thoughts?