fix: links in docs, docstring warning and theme override - Githubissues

kreshuklab / plant-seg

A tool for cell instance aware segmentation in densely packed 3D volumetric images

https://kreshuklab.github.io/plant-seg/

MIT License

89 stars 30 forks source link

fix: links in docs, docstring warning and theme override #269

Closed qin-yu closed 1 month ago

qin-yu commented 1 month ago

There have been lots of warnings during mkdocs serve, which add complexity and may cause issues. Let's fix it before getting worse. In this PR, I

fix broken links due to migrating from README.md to Jupyter Book
fix broken links due to migrating from Jupyter Book to MkDocs
fix wrong format in docstring that breaks automatic API docs
fix MkDocs colours overridden in some pages by screenshot-generation script
fix magicgui windows not closed after building MkDocs

One warning that I haven't managed to fix:

https://github.com/pawamoy/markdown-exec/issues/48