search

mansenfranzen / autodoc_pydantic

Seamlessly integrate pydantic models in your Sphinx documentation.
MIT License
159 stars 27 forks source link

Consider dropping support for sphinx version 4.X #204

Closed j-carson closed 8 months ago

j-carson commented 8 months ago

The intersection of folks who want to use both a very old version of sphinx and the latest pydantic is probably pretty small, and it was a burden to get Sphinx 4.X working in CI on my last PR

Supporting the current Sphinx major version and "one or two back" seems sufficient, I think.

mansenfranzen commented 8 months ago

Hi @j-carson,

I completely get your point. It requires some work to provide the backwards compatibility for older sphinx versions. You've fixed the sphinx 4 CI pipeline in your recent PR, and I very much appreciate it. However, I would like to keep sphinx 4 for now because it is still downloaded roughly 45k/day which is a bit less then 10% of overall usage (see here).

I assume many devs are stuck on older sphinx versions because they are dependent on older sphinx extensions that are not compatible with recent versions of sphinx.

For now, it's less work for us to remain backwards compatible than forcing many others to upgrade or even stop using newest versions of this package.

What do you think?

j-carson commented 8 months ago

Well it's less work for you, I suppose, since you got the fix handed to you in my PR, but tracking down a closed "won't fix" sphinx 4.X bug report to figure out how to fix the test automation wasn't a particularly great use of my time...

The number of requirements you want the package to meet has to be proportional to the amount of developer resources available to do the work.

mansenfranzen commented 8 months ago

Hi @j-carson,

Once again thanks for the time you've spent on improving and maintaining this package! Your work helps all users and developers relying on it. I've also spent several weeks of full time equivalent in initial setup and maintenance to make the user experience as good as possible for a sphinx extension. I don't get anything for this. Your work is not for me but all the users.

Especially setting up tests was rather difficult due to a lack of proper documentation and the complexity of sphinx see here. In contrast to this initial effort, it is well worth keeping backwards compatibility.