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.

Sign up for GitHub

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
Closed

Resolving pygment and mkdocstring version upgrade issues #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3eeea6
WIP on resolving pygments and mkdocstring version upgrade issues.
artisticlight May 4, 2022
88a09f6
Merge branch 'develop' of github.com:ASFHyP3/hyp3-docs into develop
artisticlight May 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/tools/asf_tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{ get_content('https://raw.githubusercontent.com/ASFHyP3/asf-tools/v0.4.0/asf_tools/README.md') }}
{{ get_content('https://raw.githubusercontent.com/ASFHyP3/asf-tools/v0.4.0/asf_tools/README.md') }}
4 changes: 3 additions & 1 deletion docs/tools/asf_tools_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.



2 changes: 1 addition & 1 deletion docs/using/sdk_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

5 changes: 3 additions & 2 deletions environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ dependencies:
- mkdocs>1.2.3
- mkdocs-material=6.2
- mkdocs-material-extensions

- hyp3_sdk=1.4.1 # also pinned in docs/using/sdk.md
- asf_tools=0.4.0 # also pinned in docs/tools/asf_tools.md
- requests
- pygments=2.11.2 # avoids breaking change in v2.12.0 impacting mkdocs-material v6.2.8
- pygments=2.12.0
- pip:
# For documentation
- mkdocs-asf-theme>=0.2.3
- mkdocs-redirects
- mkdocs-section-index
- mkdocstrings
- mkdocstrings[python]
- mkdocs-macros-plugin