Build sphinx docs #25
Conversation
Pydantic 2 changes how validators work[1], which breaks our code. For now, pin to Pydantic 1 to keep using the existing syntax. 1. https://docs.pydantic.dev/latest/migration/#changes-to-validators
pytest's handling of async tests seems to be quite different in pytest 8. Pin these for now so the tests continue to work.
This matches what's currently used in Azafea. It would be better to 3.11 matching stable Endless OS and Debian, but that brought in too much breakage and will need to wait for another day. It also would have been possible to stick with 3.7, but many of the dependencies have dropped support for it and trying to operate pipenv using the 3.7 from pyenv fails for me. Just use 3.8 for now.
With the pins in place, update all the dependencies so they're separated from the subsequent sphinx addition.
dbnicholson
force-pushed
the
sphinx
branch
2 times, most recently
from
7ac5094 to
c65b025
Compare
This is basically copied verbatim from azafea. The only missing part is the Read the Docs integration.
| @@ -11,7 +11,7 @@ pytest-mypy = ">=0.3.3" | |||
| [packages] | |||
| aiohttp = ">= 3.5.0" | |||
| aioredis = "~= 1.3" | |||
| pydantic = ">= 1.1" | |||
| pydantic = "~= 1.1" | |||
There was a problem hiding this comment.
I ran into this in my failed attempt to upgrade Azafea proper to a modern Python. I should learn from you and just pin the last working version!
There was a problem hiding this comment.
The obvious downside is that you end up pinning to something that's no longer supported. Unless you have a plan to come back and handle the migration, you might just be using an insecure package.
|
Looks good, except for the minor problem that the build seems to fail. |
|
Yeah, this is definitely not working. I kept trying to poke through the issues locally but haven't gotten there yet. I would say that pipenv is not your friend when you've let it go stale and it tries to go into "update the world" mode. |
In #33 I have configured Dependabot to keep Python dependencies up to date. Of course that doesn't make the current problem go away – we'll still need to figure out the "update the world" situation – but maybe it'll help in future. |
This is copied from azafea and should have been straightforward in the last commit. Unfortunately, a tangent into dependency handling and python version was needed. See the commits for details.