[Tracker] Initial Documentation Website

[so-rose]

The goal is to able to say "bpy_jupyter is ready to use". It shouldn't be confusing to start using it, or continue learning it. That requires documentation - even if not every nook and cranny is documented (yet).

This Issue tracks the implementation of this initial documentation website for the program.

• Overview: A solid overview to the program.
• User Guide: This is the hand-holding "how do I X" section.
• Reference: Python API documentation. Should also be high quality (__doc__s should be nice), but certainly more technically oriented.

Tooling

quartodoc has its annoyances, but its configurability makes for a very useful system.

Pages

• Overview: Essentially the project README.md, transcribed.

• User Guide

  • Getting Started: Gentle one-page introduction to making extensions with blext.
  • Tutorials: Gentle one-page introduction to making extensions with blext.

• Reference: The docstrings use Google style, but should make wide use of the supported sections (see the numpy documentation specification: https://numpydoc.readthedocs.io/en/latest/format.html)

  • bpy_jupyter.services.jupyter_kernel: Wait on Implement async Event Loop w/ipykernel==7.0.0 alpha #7 and Remove pyxll-jupyter w/Streamlined Kernel Connection #5.
  • bpy_jupyter.panels.jupyter_panel: Wait on [Tracker] Prune w/blroots #8.
  • bpy_jupyter.operators.copy_jupy_url_to_clip
  • bpy_jupyter.operators.start_jupyter_kernel
  • bpy_jupyter.operators.stop_jupyter_kernel

• Deployment: Get the website up and running.

[kolibril13]

I'm also a big fan of https://github.com/squidfunk/mkdocs-material documentation.
E.g. I've used it for the bpy-gallery examples:
https://kolibril13.github.io/bpy-gallery/n2typst_examples/

Also, I'm happy to record a YouTube How-To tutorial when it's ready :)