Keep examples in documentation up-to-date automatically

[speller26]

Describe the feature you'd like

The list of examples in the documentation is manually constructed, and is prone to going out-of-date with the addition of new notebooks in amazon-braket-examples.

This should be updated to automatically pull examples from the notebooks in amazon-braket-examples.

How would this feature be used? Please describe.

Having the documentation examples update automatically ensures that examples stay relevant and removes the mental load of constantly checking the list to add or remove entries.

Requirements

Update the doc generator to use the entries of amazon-braket-examples as the source of truth for the table of contents.

About unitaryDESIGN 2026

• This issue is part of unitaryDESIGN 2026; note that you have to be registered to complete this issue. Learn more about the PR review process here.
• A message from unitaryDESIGN about AI Slop: "While we are open to collaboration with LLMs for unitaryDESIGN, please note that fully AI-generated PRs are not acceptable. It is up to the discretion of the individual maintainers whether or not LLM-generated PRs are the right fit for their issues, and they have the right to reject those that appear fully AI-generated."
• Learn more about unitaryDESIGN rules and opportunities here!

[sesmart]

Does the BDK need to explicitly reference the examples at all (seems somewhat cyclical), or can it just point to them? I would think in this particular doc page, the API docs are of more interest than the examples.

[rmshaffer]

@DavinderJolly can you please add a comment on this issue, so that GitHub allows me to assign it to you? (for your PR #1217, which will solve this)

[DavinderJolly]

@rmshaffer ^^ commenting to be assigned, thanks!