Open wolny opened 7 months ago
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:
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 : )
Oh no! :( I hope you have speedy recovery!
@lorenzocerrone @wolny
docs/chapters/
master
, see https://github.com/hci-unihd/plant-seg/blob/master/.github/workflows/build-deploy-book.ymlOops forgot to tell you the local steps @lorenzocerrone @wolny :
pip install -r docs/requirements.txt
to use Jupyter Book locally for visualisationjupyter-book build . --all
to build and use a browser to checkSphinx 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
Add short videos with description for key functionalities: