Docs

[bnmajor]

Addresses #16

[bnmajor]

@thewtex This covers most of the topics covered in #16 but there are some pieces that are missing. I need some clarification on what the following sections should be actually be covering:

• Deployments
  • Server app
  • Desktop app
• Integrations: Should this just be covering installation and maybe an example of using that dependency?
• Jupyterlite and VSCode are not yet covered in the docs as there are still issues with both that I am trying to sort out. VSCode is not displaying the viewer (although it also does not produce errors and works perfectly in Jupyter) and Jupyterlite has issues with installation as it requires pure python wheels for all packages (must be installed with piplite):

  ValueError: Couldn't find a pure Python 3 wheel for: 'multidict<5.0,>=4.5', 'yarl<2.0,>=1.0'
  

[thewtex]

I need some clarification on what the following sections should be actually be covering

Let's cover the sections we do not have content for in a follow-up PR.

Integrations: Should this just be covering installation and maybe an example of using that dependency?

👍 both :-)

[labdala]

Hey @bnmajor, this set up looks great! I love the screenshots you added.
Here are some tips that I just learned and would like to share with you:

• You may consider using MyST. It lets you write everything using markdown, which I find much easier than RestructuredText.
• I ran into this "extension error" when using the pydata-sphinx-theme:

'HtmlFormatter' object has no attribute 'get_linenos_style_defs'

and learned that we need pygments v2.11.2 or above(?) to have it working. I am not sure if this is the best practice, but I added that as a requirement in my txt file.

Please feel free to comment and suggest changes on PR too.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[thewtex]

Loving the screenshots! 😍

[bnmajor]

@thewtex This adds the integrations section as well as screenshots, support for the listed integrations, and new notebook examples. Two things to address though:

1. I do not have permissions to add a webhook to get readthedocs set up
2. Was the zarr example notebook that you added working for you? I was able to download the data locally and test it to get the screenshot but actually running the notebook does not work for me (I can open a separate issue/PR for this if this is a bug)

[thewtex]

I do not have permissions to add a webhook to get readthedocs set up

Could you please add my account to the ReadTheDocs project?

Was the zarr example notebook that you added working for you? I was able to download the data locally and test it to get the screenshot but actually running the notebook does not work for me (I can open a separate issue/PR for this if this is a bug)

Yes, it was -- please create an issue.

Thanks!

[bnmajor]

I do not have permissions to add a webhook to get readthedocs set up

Could you please add my account to the ReadTheDocs project?

I added you as a maintainer so you should be able to access it now: https://readthedocs.org/projects/itkwidgets/. If not let me know, there may be additional steps I need to take.

Was the zarr example notebook that you added working for you? I was able to download the data locally and test it to get the screenshot but actually running the notebook does not work for me (I can open a separate issue/PR for this if this is a bug)

Yes, it was -- please create an issue.

Great will do, thanks!

[bnmajor]

FYI @thewtex #460 has the traceback for the error that I am seeing

[thewtex]

I added you as a maintainer so you should be able to access it now: https://readthedocs.org/projects/itkwidgets/. If not let me know, there may be additional steps I need to take.

Thanks. I enabled the GitHub Integration. It should be working now.

[bnmajor]

Thanks. I enabled the GitHub Integration. It should be working now.

Thanks! I think everything is all set with that now, docs should build on pull requests and the default branch is set to main.