Skip to content

Docs: Add full examples to readthedocs #189

@brendanreardon

Description

@brendanreardon

Feature description

At the moment, only snippets from examples are included under Constraints or Recipes. There should be an option to view full examples within the readthedocs.

Some potential options:

  1. Link out to the example .yaml and .json files on GitHub.
  2. Add orphan pages on readthedocs for each .json and .yaml example. These can be hyperlinked next to each example's drop down when used in the docs.
  3. Add a section called "Examples" that includes headers for each example. There, we can include .yaml and .json full examples and migrate the documentation for Examples to the readthedocs

Contribution

None

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions