Skip to content

Actually fix our docs build#159

Merged
wgreenberg merged 1 commit intomasterfrom
fix-docs-attempt2
Mar 7, 2023
Merged

Actually fix our docs build#159
wgreenberg merged 1 commit intomasterfrom
fix-docs-attempt2

Conversation

@bmw
Copy link
Copy Markdown
Member

@bmw bmw commented Mar 7, 2023

#157 fixed the problem locally, but failed on readthedocs. I believe that failure is due to python-poetry/poetry-plugin-export#168.

To fix this, I just unconditionally tightened our Sphinx dependency. While I initially tried not to do this, I don't think it's worth the effort and I really doubt it will be a problem for people. If it is, we can always consider doing something fancier in a followup release. I also changed the minimum version to 4.3.0 based on Sphinx's changelog.

Unfortunately, that change wasn't enough though because poetry then selected an ancient version of flake8 that fails on Python 3.7. I fixed this by also specifying a minimum version of that package. The need to keep tracking down minimum versions like this feels somewhat annoying to me, however, in poetry's defense, each solution it presented was valid from its perspective with the dependencies we had specified (until now). I don't think the tigher flake8 dependency will be a problem since it's just used for testing.

Finally, I tested all of this actually on readthedocs and it passed. See https://readthedocs.org/projects/josepy/builds/19706627/.

This was referenced Mar 7, 2023
@wgreenberg
Copy link
Copy Markdown
Contributor

ack, good catch! also thanks for the writeup, i was pretty mystified by the error poetry gave.

@wgreenberg wgreenberg merged commit 19e300d into master Mar 7, 2023
@wgreenberg wgreenberg deleted the fix-docs-attempt2 branch March 7, 2023 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants