Update to tests, update relative links, and delete files that are no longer used - Githubissues

QuantEcon / sphinxcontrib-jupyter

A Sphinx Extension for Generating Jupyter Notebooks

BSD 3-Clause "New" or "Revised" License

74 stars 23 forks source link

Update to tests, update relative links, and delete files that are no longer used #276

Closed sglyon closed 4 years ago

sglyon commented 4 years ago

There are three commits here:

Change execution behavior of link translator. We were removing relative paths from the links, but that was breaking things. The updated tests show that
Test subfolders with diff checker, not just root directory documents
Removed a bunch of files that don't seem to be used anymore

This is needed for some changes in the datascience lectures as some links are currently broken.

For example, in pandas/intro.rst we try to link to pyfun/intro.rst by doing :doc:Python basics <../pyfun/basics.rst>`

Before this commit the .. was being removed so the link in theoutput ended up being pandas/pyfun/basics.(html|ipynb) when it should be ../pyfun/basics.(html|ipynb)

mmcky commented 4 years ago

thanks @sglyon I have a PR #268 in the works for more robust static file linking. It builds an image and download library and copies over those files actually used in the RST files.

It is also something flagged for more attention in the November rewrite of the extension as sphinx handles uri different for images and downloads and the state is pretty confusing. There are cases where sphinx removes some part of the specified links and cases where it adds subfolders to other parts of the reference link and you end up with subfolder/../file paths which clearly don't work.

mmcky commented 4 years ago

[x] has https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/276/commits/334d4a9976f220c21308abd123a1984bdd363dbb this been tested on subfolders or nested folder context?

It looks like the links are correct for the base/section2 test cases. I will take a closer look at this and alter #266 as required. Thanks @sglyon I will delete this line once merged into master.

mmcky commented 4 years ago

[x] the rst2ipynb files are the tests cases provided to me by the rst2ipynb project run by Sage. I think we have captured all the necessary elements from those test cases so we can delete these. They are references cases that was really helpful when building our own test set. So thanks to rst2ipynb for providing them.

mmcky commented 4 years ago

[x] @sglyon do we need recursive = True for the glob to run through the directory tree? python=2.7 support is coming to an end but we should probably keep this working in that context for now.

mmcky commented 4 years ago

@sglyon I made a few adjustments to this branch and I think we can go ahead and merge it. I will do so now and then update my PR with the latest master

sglyon commented 4 years ago

Thanks @mmcky!