Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix documentation build and docs #113

Merged
merged 1 commit into from
Aug 9, 2022

Conversation

tk-woven
Copy link
Collaborator

@tk-woven tk-woven commented Aug 8, 2022

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 from rinohtype were failing to compile. This work fixes the docs build and also updates the documentation for completeness.

m2r2, which requires mistune, was having us install the newer version of mistune that breaks against the Sphinx API, so we have to update m2r2 to use a version that pins against the older mistune.


This change is Reviewable

@tk-woven tk-woven force-pushed the fix/tyler-kowallis/fix-docs-build branch 2 times, most recently from 502c110 to 18e20b2 Compare August 9, 2022 00:13
Copy link
Collaborator

@wadimkehl wadimkehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 2 of 2 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @chrisochoatri and @kuanleetri)

@tk-woven tk-woven merged commit bed9e4d into TRI-ML:master Aug 9, 2022
@tk-woven tk-woven deleted the fix/tyler-kowallis/fix-docs-build branch August 9, 2022 00:23
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