Video tutorials
Opened this issue · 11 comments
Add short videos with description for key functionalities:
- proofreading (Lorenzo)
- network prediction (Adrian)
- segmentation (Adrian)
- pre-/post-processing (Lorenzo)
When you think it's time, I can quickly put them in GitHub Pages by Actions in readthedoc style. I've been using that for another project. If you want the changes to be reflected in commits, we can start migrating from the existing Wiki now.
We can do either:
- we update the doc in main branch, and when we want to officially update the doc, we sync the publication branch with our main, which triggers the Action that compiles it into a real doc on GitHub Pages.
- we update the doc in main branch, and the Action updates the doc webpage on each commit.
The raw doc can be a standalone repo, or it can be a /doc folder.
Hey @qin-yu that would be amazing, do you have some time to setup the template? If yes I agree to move the docs to github pages
@lorenzocerrone maybe by Monday. Is it fine?
That would awesome! But I would say that anytime next week would be good, no need to crunch for finishing it by monday :)
@lorenzocerrone I got covid on Saturday : )
- See #179
Oh no! :( I hope you have speedy recovery!
- https://github.com/hci-unihd/plant-seg/tree/master/docs/chapters contains the markdown files for documentation
- https://github.com/hci-unihd/plant-seg/blob/master/docs/_toc.yml is the table of content <-- this needs to be modified if you want to add/remove/rename markdowns in
docs/chapters/ - Website of docs updates on every new push on
master, see https://github.com/hci-unihd/plant-seg/blob/master/.github/workflows/build-deploy-book.yml
Oops forgot to tell you the local steps @lorenzocerrone @wolny :
- create a new env and
pip install -r docs/requirements.txtto use Jupyter Book locally for visualisation - run
jupyter-book build . --allto build and use a browser to check
Sphinx systems allows API reference from docstrings. For the API section of our documentation, we can refer to this section: https://jupyterbook.org/en/stable/advanced/developers.html#api-reference-from-docstrings
Current jupyter book documentation site is decent. I used it with the expectation that code blocks could run at build. But it may not be as practical as I thought.
Here I found many packages uses this mkdocs framework, which looks better though it's more static:
I have a very small preference for mkdocs, but both are equally good to me