Fix rendering of documentation derived from source code at hyp3-docs
#369
Labels
Jira Bug
Create a Jira Bug for this issue
hyp3-docs
#369
Jira: https://asfdaac.atlassian.net/browse/TOOL-2261
Note: The above link is accessible only to members of ASF.
mkdocs-asf-theme
upgrade (see Upgrademkdocs-material
mkdocs-asf-theme#38) to https://jhkennedy.org/hyp3-docs, I'm seeing an issue where the file paths in source code blocks fail to render if they're too long, e.g. see the source code blocks at the top of https://jhkennedy.org/hyp3-docs/using/sdk_api/. After deploying the upgrade to our productionhyp3-docs
website, we should confirm that the problem still exists at https://hyp3-docs.asf.alaska.edu/using/sdk_api/. The solution would be to convert the file paths to relative paths, e.g./usr/share/miniconda/envs/hyp3-docs/lib/python3.9/site-packages/hyp3_sdk/jobs.py
should behyp3_sdk/jobs.py
(which we should do regardless of the file path rendering issue).>>>
, the corresponding documentation renders strangely, e.g. https://hyp3-docs.asf.alaska.edu/tools/asf_tools_api/#asf_tools.tile. Maybe using backticks in the docstring would help?The text was updated successfully, but these errors were encountered: