ipums / ipumspy

Mozilla Public License 2.0
8 stars 6 forks source link

Fix readthedocs build #63

Closed khwilson closed 2 years ago

khwilson commented 2 years ago

Seems like there's some funny business (as always) in the world of python packaging. There is a very helpful thread on readthedocs github:

https://github.com/readthedocs/readthedocs.org/issues/4912

Looking through some other people who have fought through this, the main issues seem to be that:

This commit responds to all these issues. Thanks especially to this super helpful commit basically showing the way:

https://github.com/TeoZosa/structlog-sentry-logger/commit/f4913dcb3c39bb1b4cf7247a0ac7641aa31f35f9

I've tested this on a fake repo setup just to test rtd:

https://testxxxxxtest.readthedocs.io/en/latest/

This seesm to be working. :-)

codecov[bot] commented 2 years ago

Codecov Report

Merging #63 (fa0ed7a) into master (02b7e7a) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #63   +/-   ##
=======================================
  Coverage   76.31%   76.31%           
=======================================
  Files          12       12           
  Lines         591      591           
=======================================
  Hits          451      451           
  Misses        140      140           

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 02b7e7a...fa0ed7a. Read the comment docs.

renae-r commented 2 years ago

Amazing! One question: In the example commit linked above there is still a requirements.txt file that only contains poetry. Why do we not need that?

khwilson commented 2 years ago

It doesn’t seem so. I think this is all happening in the backend via things like PEP 660. Specifically, in the “build-system” section of the pyproject.toml is where a lot of this is getting specified.