Python code examples

[Mandrenkov]

Context:
Presently, the Using Jet section of the Sphinx documentation does not contain any Python code examples. This PR primarily adds an equivalent Python code snippet to each existing C++ code snippet using the sphinx-tabs extension.

Description of the Change:

• The project README now has Python installation instructions and a corresponding hello world program.
• Each C++ code block featured in a Using Jet tutorial is now paired with an equivalent Python code block.
  • Clicking the "C++" or "Python" tab of any code example applies the same change to all the other examples.

Benefits:

• New Python users can quickly learn how to install Jet and follow along with the high-level Jet tutorials.

Possible Drawbacks:

• The README appears a bit longer which may discourage some developers from reading it thoroughly.

Related GitHub Issues:
None

[github-actions]

Test Report (C++) on Ubuntu

    1 files  ±0      1 suites  ±0   0s ⏱️ ±0s
521 tests ±0  521 ✔️ ±0  0 💤 ±0  0 ❌ ±0 
870 runs  ±0  870 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ddb21f9. ± Comparison against base commit 29805e4.

♻️ This comment has been updated with latest results.

[github-actions]

Test Report (C++) on MacOS

    1 files  ±0      1 suites  ±0   0s ⏱️ ±0s
521 tests ±0  521 ✔️ ±0  0 💤 ±0  0 ❌ ±0 
870 runs  ±0  870 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ddb21f9. ± Comparison against base commit 29805e4.

♻️ This comment has been updated with latest results.

[josh146]

Looks wonderful! I love how the sphinx tabs work.

All my comments are minor so I'm happy to approve. The only one that should be addressed is that the sphinx docs keep referring to 'installation instructions', however every link seems broken. It is currently pointed to /use/installing.html? I also couldn't find installation instructions in the ToC?

Oh, I just realized it should be pointing to the Development Guide? As a 'user' that wants to install Jet but not develop for it, I kept looking for an 'Install' or 'Getting Started' page in the 'Using Jet' section.

[Mandrenkov]

Looks wonderful! I love how the sphinx tabs work.

Awesome!

The only one that should be addressed is that the sphinx docs keep referring to 'installation instructions', however every link seems broken.

Thanks for catching that - it's fixed now.

I also couldn't find installation instructions in the ToC?

Ah, you can find those instructions under "Development Guide" (similar to SF).

Oh, I just realized it should be pointing to the Development Guide? As a 'user' that wants to install Jet but not develop for it, I kept looking for an 'Install' or 'Getting Started' page in the 'Using Jet' section.

I agree with you although neither PL or SF have an explicit section in the ToC for installation instructions. Perhaps this is something we should change across all of the Xanadu OSS projects?

[josh146]

I agree with you although neither PL or SF have an explicit section in the ToC for installation instructions. Perhaps this is something we should change across all of the Xanadu OSS projects?

They used to --- we since moved this to the main navbar, since we wanted to make it as accessible as possible:

The Walrus is the one exception - here, it remained in the Sphinx TOC:

This is (partly) because including it in the main navbar involved working out how to get Sphinx to include static pages in the build (or something like that). Doable, we just never got around to it!

[Mandrenkov]

Oh, true - I forgot about the navbar! We should definitely add an "Install" link there once the main website is live since the static HTML page approach used by SF feels like a bit of a maintenance burden.