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

DOCS: Add GitHub support to copyfiles, remove online notebook downloads #1087

Merged

Conversation

dwhswenson
Copy link
Member

In order to move notebooks into the right locations, a while ago I added a copyfiles script to our docs directory. This is specifically used to bring our docs from examples into the docs, where Sphinx can find them.

Today, I discovered that it was using GitLab to download (very outdated) copies of our tutorial notebooks. So I updated the script to allow us to use GitHub instead.

Then I realized that I we're not even using those downloaded notebooks in our docs. 🤷‍♂️ It definitely makes more sense to just link to the repositories, especially given the option of launching the tutorial with Binder.

In any case, I left the addition of support for GitHub, and removed the downloads of the tutorial notebooks from online (this also would have been an annoyance to anyone trying to build our docs without internet connectivity). I left previous usage commented as an example for any future users.

This should be immediately ready for review.

@dwhswenson dwhswenson added misc PR docs issues/PRs related to documentation labels Nov 1, 2021
Copy link
Member

@sroet sroet left a comment

Choose a reason for hiding this comment

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

LGTM

@codecov
Copy link

codecov bot commented Nov 1, 2021

Codecov Report

Merging #1087 (60eb8eb) into master (0ca38e4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1087   +/-   ##
=======================================
  Coverage   81.56%   81.56%           
=======================================
  Files         140      140           
  Lines       15452    15452           
=======================================
  Hits        12604    12604           
  Misses       2848     2848           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0ca38e4...60eb8eb. Read the comment docs.

@dwhswenson dwhswenson merged commit ddfe508 into openpathsampling:master Nov 1, 2021
@dwhswenson dwhswenson deleted the docs-github-copyfiles branch November 1, 2021 19:25
@dwhswenson dwhswenson mentioned this pull request Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs issues/PRs related to documentation misc PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants