Add documentation folder and Actions for https://hci-unihd.github.io/plant-seg/ #179
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Lorenzo Cerrone <[email protected]> Co-authored-by: Adrian Wolny <[email protected]>
qin-yu
added
documentation
Open
|
Fantastic job! Thanks Qin! I looks good to me |
|
Awesome! Thx @qin-yu |
|
Repo home's description now use Pages as the website. |
|
New footer for Wiki:
|
|
I disabled Wiki (and Projects). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
publishto 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
blobURL, but here we can only userawURL, see https://gist.github.com/qin-yu/cb9039b0eda130c4ea14ae330a74e8b1If the doc grows we can automate the ToC generation in the future.