🚸 Add tutorials to user docs

shnizzedy commented 2 years ago

Documents

Documents https://github.com/FCP-INDI/C-PAC/pull/1701 by @shnizzedy

Description

Adds tutorials from FCP-INDI/C-PAC_tutorials to https://fcp-indi.github.io/docs/nightly/user/tutorials

Technical details

Clones FCP-INDI/C-PAC_tutorials into docs/_sources/user/tutorials
Uses nbsphinx to build the docs from the notebooks

Screenshots

sidebar user guide index fcp-indi.github.io/docs/nightly/user/tutorials

Checklist

[x] My pull request has a descriptive title (not a vague title like Update index.md).
[x] My pull request targets the source branch of the repository.
[x] My commit messages follow best practices.
[x] My code follows the established code style of the repository.
[ ] I added tests for the changes I made (if applicable).
[ ] I updated the changelog.
[x] I added or updated documentation (if applicable).
[x] I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```

shnizzedy commented 2 years ago

@gkiar I think the plot weirdness is actually an error from the full-page-screenshot extension I used. They look okay in https://github.com/FCP-INDI/C-PAC_tutorials/blob/6b2ffe440ee887410b5584d5789b73fe8436b5cb/observed_usage/index.ipynb and on my built fork (https://shnizzedy.github.io/fcp-indi.github.io/docs/nightly/user/tutorials/observed_usage)

recaptured/copied

(The images are kind of huge though. Maybe I should update the CSS)

shnizzedy commented 2 years ago

I'm not sure if this is a great rule, but I set images in paragraphs in tutorials to have a max-width of 80% unless otherwise specified. That looks like this:

smaller images

gkiar commented 2 years ago

Makes sense @shnizzedy , nice! This is awesome

FCP-INDI / fcp-indi.github.io