Fixup documentation links #61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
bpkroth
commented
Sep 9, 2020
bpkroth
commented
Sep 9, 2020
| # NOTE: These are also somewhat expensive to execute on every single CI. | ||
| # --execute \ | ||
| # --ExecutePreprocessor.kernel_name=python3 \ | ||
| # --ExecutePreprocessor.timeout=600 \ |
bpkroth
commented
Sep 9, 2020
|
I renamed |
amueller
reviewed
Sep 9, 2020
| $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.
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.
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... |
amueller
approved these changes
Sep 10, 2020
The syntax was not cross-platform compliant.
bpkroth
commented
Sep 10, 2020
This was referenced Sep 10, 2020
This was referenced Sep 10, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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=Truefixup 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.