doc: Tesseract Bootcamp and Example Gallery

[angela-ko]

Relevant issue or PR

Description of changes

Logic inside the actual example is a dummy still -- just a quick PR to show the current design.

Use sphinx title cards to showcase howto guides

Due to the nature of Tesseracts and it being not purely python code, it is difficult to use features such as sphinx testing and sphinx gallery, as these are primarily for python changes. Even in the cases where you could possibly add in non-python code for display, it is difficult because the auto-generating nature of sphinx gallery means we would need heavy handhelding to tell sphinx which files to generate and which to skip. Furthermore, testing requires environment modification such as running and building the tesseract on certain systems, etc.

Sphinx-gallery and testing also have the prereq that your logic is executable in one file, which is also not the case for Tesseracts.

Because of that, I ended up going with the original decision of just using our test-examples logic and having the logic in the how-to guides live in examples for testing, but modified so that it would look more visually like sphinx-gallery.

Added a Tesseract bootcamp tutorial along with some basic examples (not fleshed out).

Testing done

Clicking around the site, going through bootcamp and testing it, having someone be my labrat

License

• [ x] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
• [ x] I sign the Developer Certificate of Origin below by adding my name and email address to the Signed-off-by line.

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

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.

Signed-off-by: Angela Ko [email protected]

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.59%. Comparing base (f13fcff) to head (a4ba40c).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #149   +/-   ##
=======================================
  Coverage   75.59%   75.59%           
=======================================
  Files          27       27           
  Lines        2946     2946           
  Branches      456      456           
=======================================
  Hits         2227     2227           
  Misses        517      517           
  Partials      202      202           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[angela-ko]

@xalelax Could I get some eyes on this PR since Dion is OOO for the next few weeks?

Summary:

• This PR moves the 2 how-to guides we have from tesseract-forums into examples/
• Added an example-gallery subpage on the readthe docs website (Can view by running make html in the docs/ folder and open build/html/content/examples/example_gallery.html).
• Populated the text in the examples (this is a subset since theres some that are bit more complex that I'm not certain how to write the descriptions for yet).

Pending Issues:

• The pyvista-arm64 build instructions on the forum doesn't actually work for me, so I have temporarily modified it to just a regular linux build using pyvista so that I can validate that the pyvista testing logic is actually working.
• Local dependency test not passing yet