search

kreshuklab / plant-seg

A tool for cell instance aware segmentation in densely packed 3D volumetric images
https://kreshuklab.github.io/plant-seg/
MIT License
90 stars 31 forks source link

Add documentation folder and Actions for https://hci-unihd.github.io/plant-seg/ #179

Closed qin-yu closed 9 months ago

qin-yu commented 9 months ago

I created a Jupyter Book (Sphinx) based doc structure. Jupyter Book allow us to include Jupyter Notebook style code block and its actual ouptut in the doc, but before you need/do this, the book is just Sphinx. Existing Wiki is ported to it with minor modifications in links, and this commit is co-authored. The GitHub action in this branch is only for this branch, for testing. The website is at https://hci-unihd.github.io/plant-seg/

When the PR is merged, we need to change the branch to master (or a dedicated branch called say publish to reduce the frequency of Doc rebuilding) in the Action file .github/workflows/build-deploy-book.yml.

Note that in Wiki we can use GitHub hosted images with blob URL, but here we can only use raw URL, see https://gist.github.com/qin-yu/cb9039b0eda130c4ea14ae330a74e8b1

If the doc grows we can automate the ToC generation in the future.

lorenzocerrone commented 9 months ago

Fantastic job! Thanks Qin! I looks good to me

wolny commented 9 months ago

Awesome! Thx @qin-yu

qin-yu commented 8 months ago

Repo home's description now use Pages as the website.

qin-yu commented 7 months ago

New footer for Wiki:

⭐ Our New Documentation is at https://hci-unihd.github.io/plant-seg/intro.html ⭐

qin-yu commented 7 months ago

I disabled Wiki (and Projects).