rs-station / reciprocalspaceship

Tools for exploring reciprocal space
https://rs-station.github.io/reciprocalspaceship/
MIT License
28 stars 12 forks source link

Fix documentation build by lowering jinja2 version #202

Closed JBGreisman closed 1 year ago

JBGreisman commented 1 year ago

This is a quick fix to the documentation build. There is a current issue with sphinx due to a newer version of Jinja2 (https://github.com/readthedocs/readthedocs.org/issues/9037#issuecomment-1077818554).

After this fix, I'll look into making a more future-proof documentation build -- might require updating to using a more recent Python version when building documentation.

JBGreisman commented 1 year ago

This fix corrects documentation builds locally -- our current CI doesn't explicitly test the build of the documentation, and it would be a good idea to add such a check in the future.

codecov-commenter commented 1 year ago

Codecov Report

Merging #202 (0719bff) into main (e919c77) will not change coverage. The diff coverage is n/a.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main     #202   +/-   ##
=======================================
  Coverage   98.39%   98.39%           
=======================================
  Files          45       45           
  Lines        1803     1803           
=======================================
  Hits         1774     1774           
  Misses         29       29           
Flag Coverage Δ
unittests 98.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more