Add requirements.txt file for readthedocs. #8
Conversation
|
@fuzzball81 The thing is, this should be a temporary file (it is generated by pipenv based on our lock file, and is not really meant to be used by humans). I didn't want to add it at all, but for now, readthedocs doesn't seem to want to build without it. I saw they have an open issue for pipfile support[1], so I expect this file to be transient, and I will remove it the second I find readthedocs has updated their support. I agree that the SHAs are not ideal, but they are meant to be a security feature of pip (and thus pipenv). And I am a little concerned this still wont work on rtd, because we have some system requirements on pipenv install which they are not likely to have available. If this patch is merged, and the docs are still no good, I may have to look into an alternate way to get the docs over there anyway (we can compile them just fine, maybe I can just push them over already compiled - I'll look to see if that is an option). |
|
OK, I did some poking, and no luck on just pushing compiled docs up ourselves. And on further reflection, we really only have 1 dep we need to pull in - koji. I will update this to make the req.txt just have that and see what happens. I think I will likely have to add a bit I saw on the rtd documentation to stub out the required C libs, so if the doc build fails, that will be the next round. |
Hopefully this gets fixed soon, but currently readthedocs doesn't support Pipfile, only requirements.txt. This should require few updates, as this project is not intended to have a lot of other dependencies. Signed-off-by: Jason Guiditta <[email protected]>
|
OK, tests are good, if you are ok with current rev, let's get it in and see if it is enough to get the full docs. If not, I'll submit additional PRs to get there |
Hopefully this gets fixed soon, but currently readthedocs doesn't
support Pipfile, only requirements.txt. This patch freezes what we have
managed by pipenv currently, and should be updated as Pipfile/lock are
updated until readthedocs gets the support we need.
Signed-off-by: Jason Guiditta [email protected]