docs: add examples to the RTD

[kairoaraujo]

This commit adds to the RTD the links references to source code
examples.
The examples are added to TUF ngclient Updater and Metadata.

Fixes #1716

Signed-off-by: Kairo de Araujo kdearaujo@vmware.com

• The code follows the Code Style Guidelines
• Tests have been added for the bug fix or new feature
• Docs have been added for the bug fix or new feature

[coveralls]

Pull Request Test Coverage Report for Build 1712643674

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+1.0%) to 98.676%

---

Totals
Change from base Build 1711894519:	1.0%
Covered Lines:	3937
Relevant Lines:	3960

---

💛 - Coveralls

[lukpueh]

Thanks for the patch! I think it would drastically improve discoverability of the examples, if they were referenced in the main menu too, e.g.:

• API Reference
• Installation
• Usage examples
• Instructions for Contributors

We can decide later if we create a dedicated examples landing/overview page on RTD, or in a README.md in the examples directory. For the time being the menu item could simply link to the examples directory in the repo. What do you think? Would you mind updating your PR to do this?

[kairoaraujo]

We can decide later if we create a dedicated examples landing/overview page on RTD, or in a README.md in the examples directory. For the time being the menu item could simply link to the examples directory in the repo. What do you think? Would you mind updating your PR to do this?

I think it is good. My only concern was what you already mentioned, going out from the RTD without a landing page in the examples and being out of the RTD.
I don't mind updating the PR :)

Maybe as we don't have a README:

• API Reference
• Installation
• Usage examples
  • client code example
  • repository code example
• Instructions for Contributors

I am also ok with your suggestion.

[lukpueh]

I slightly lean towards not having sub-items in the menu in order to not convolute it. If you don't mind the effort, I'd prefer if you just added a barebones README.md to the examples folder with a similar paragraph that you already wrote for this PR.

[lukpueh]

Thanks for addressing my comments!

[lukpueh]

Works for me to start with! 👍