Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix example rendering when example contains an asdf_standard requirement #90

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

braingram
Copy link
Contributor

@braingram braingram commented Feb 19, 2024

Schema examples can contain >2 items when they contain an asdf_standard requirement (as seen in the current time-1.2.0 schema:
https://github.com/asdf-format/asdf-standard/blob/6aa1f965607dc2e6bc1e69da8479a335026e3c49/resources/schemas/stsci.edu/asdf/time/time-1.2.0.yaml#L36-L40

  -
    - Example ISO time
    - asdf-standard-1.6.0
    - |
        !time/time-1.2.0 "2000-12-31T13:05:27.737"

These examples currently do not render properly with sphinx-asdf where the entire example becomes asdf-standard-1.6.0. See https://asdf-standard.readthedocs.io/en/1.0.3/generated/stsci.edu/asdf/time/time-1.2.0.html#Examples

This PR fixes the above issue.

@braingram braingram marked this pull request as ready for review February 19, 2024 20:31
@braingram braingram changed the title fix example rendering when example contains a asdf_standard requirement fix example rendering when example contains an asdf_standard requirement Feb 19, 2024
@braingram braingram merged commit 20df236 into asdf-format:main Feb 23, 2024
21 of 22 checks passed
@braingram braingram deleted the example_standard_def branch February 23, 2024 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants