Fix doc dependencies

[kclowes]

What was wrong?

Doc builds started failing.

How was it fixed?

• Added a Jinja2 requirement of >=3.0,<3.1.0. Jinja3.1 breaks our docs with the following error: ImportError: cannot import name 'contextfunction' from 'jinja2'
  • See also: RDT build suddenly starts failing without any changes in conf.py readthedocs/readthedocs.org#9037
• Pinned towncrier to a certain version since they don't follow semver
• Tested higher sphinx versions and opened up the sphinx version requirement

To-Do

• Clean up commit history

• Add entry to the release notes

Cute Animal Picture

[pacrob]

lgtm

[carver]

Oh no, say it aint so! Did towncrier confirmed this in their docs somewhere?

Is there some interdependency that fails on more recent versions when towncrier is more recent? Just curious which API is changing that we are using.

I also got bitten by this issue in working on eth-portal. (I haven't run into a towncrier issue yet, but I also haven't generated any release notes) See: ethereum/eth-portal@6ad0733

I suppose all these doc dependencies should get pinned here, too, then:
https://github.com/ethereum/ethereum-python-project-template/blob/b88fcf3c0b70ea7e4bd0fbc89b546a37877ce50e/setup.py#L20-L23
(whether the version you picked here, or the path I took)

(Plus, the commentary about why, and when the dependencies can change again.)

[kclowes]

Did towncrier confirmed this in their docs somewhere?

No, but if you look at their release history on pypi you can see it used to be year.month.something and now I'm not sure what the pattern is.

The problem for us is that more recent versions than 18.5.0 were adding a double header on our releases. I suspect because it wasn't respecting the custom format that we had.

I suppose all these doc dependencies should get pinned here, too

good thought!

[carver]

The problem for us is that more recent versions than 18.5.0 were adding a double header on our releases. I suspect because it wasn't respecting the custom format that we had.

Oh interesting, that's what it was!

[carver]

https://github.com/twisted/towncrier/blob/master/NEWS.rst#towncrier-2190-2022-02-04

Looks like it was fixed in 21.9.0!