TRI-ML / dgp

ML Dataset Governance Policy for Autonomous Vehicle Datasets
https://tri-ml.github.io/dgp/
MIT License
93 stars 63 forks source link

fix: fix documentation build and docs #113

Closed tk-woven closed 2 years ago

tk-woven commented 2 years ago

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