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

Resolving pygment and mkdocstring version upgrade issues #204

Closed
wants to merge 2 commits into from

Conversation

artisticlight
Copy link
Collaborator

No description provided.

@artisticlight artisticlight requested a review from a team May 5, 2022 05:00
@@ -1,3 +1,5 @@
# `asf_tools` *v0.4.0* API Reference

::: asf_tools
{{ get_content('https://raw.githubusercontent.com/ASFHyP3/asf-tools/v0.4.0/asf_tools/README.md') }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this pin-points the issue to something going on with the mkdocstrings plugin, this change make it so our API reference:
https://hyp3-docs.asf.alaska.edu/tools/asf_tools_api/

renders as just our README.md:
https://hyp3-docs.asf.alaska.edu/tools/asf_tools/

IF we really can't get mkdocstrings to work, which is highly undesirable, it'd be better to eliminate this API reference page entirely.

@@ -1,3 +1,3 @@
# `hyp3_sdk` *v1.4.1* API Reference

::: hyp3_sdk
{{ get_content('https://raw.githubusercontent.com/ASFHyP3/hyp3-sdk/v1.4.1/README.md') }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise, this change make it so our SDK API reference:
https://hyp3-docs.asf.alaska.edu/using/sdk_api/

renders as just our SDK README.md:
https://hyp3-docs.asf.alaska.edu/using/sdk/

and again, if we really can't get mkdocstrings to work, it'd be better to eliminate this API reference page entirely.

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.

3 participants