fix: fix documentation build and docs #113
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In an attempt to address a CVE (CVE-2022-34749) for one of our docs dependencies,
mistune
, I found multiple issues. The first is that we cannot address the CVE until some Sphinx API issues are solved in upstream Sphinx. The second issue is that our docs building is broken, presumably by the update to Python 3.7 as some regexs fromrinohtype
were failing to compile. This work fixes the docs build and also updates the documentation for completeness.m2r2
, which requiresmistune
, was having us install the newer version ofmistune
that breaks against the Sphinx API, so we have to updatem2r2
to use a version that pins against the oldermistune
.This change is