-
Notifications
You must be signed in to change notification settings - Fork 65
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
Fixup documentation links #61
Conversation
some in preparation to redo the way we convert links when publishing to github pages
reuse, comments, more dependency install, etc.
this makes it easier to test locally
syncing work from laptop
# NOTE: These are also somewhat expensive to execute on every single CI. | ||
# --execute \ | ||
# --ExecutePreprocessor.kernel_name=python3 \ | ||
# --ExecutePreprocessor.timeout=600 \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These currently fail. I haven't debugged it yet, but looked to be similar to the Shell=True
fixup from #46
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The intent here was to handle #55 while I was at it.
I renamed |
$pythonCmd -m pip install jupyter nbconvert | ||
|
||
# execute and render the notebooks to html | ||
# downgrade html output because hugo doesn't like raw html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might not be obvious what part this is refering to. That's the config file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the lower comment was originally yours. The diff is probably just confused by the number of changes. I'm happy to take suggestions on updating it to be more clear.
damn forgot to press "comment" when I reviewed it... |
The syntax was not cross-platform compliant.
A bunch of work for fixing up some broken documentation links and improving the pipelines to try and prevent that in the future.
Uses a fake anchor hack discussed previously to identify which links, when rendered in github pages, should be sent back to the main github repo page, and which should remain relative, though suitably fixed up.
Adds a Makefile for building the site both locally (for testing) as well as in the pipelines.
This also fixes a an issue with the python_api code being copied to the wrong location so it wasn't being updated.
Adds a workflow to test for broken links in the plain markdown files as well.
None of them check for faulty anchors.
Partial work on providing the ability to execute the notebooks prior to markdown rendering as well (there's a bug that seems to be related to the recent
shell=True
fixup from #46 I haven't addressed there yet though).For that we also needed the ability to install all of the necessary pip modules. I tried to add a script to avoid use of requirements.txt and instead use the conda environment.yml without actually making use of conda (kind of a hack for the moment).
Eventually I intend to replace that with proper docker container build image reuse.