Page MenuHomeSoftware Heritage

Please use docutils instead of pypandoc
Closed, ResolvedPublic

Description

When reviewing the size of swh.web dependencies, @douardda noticed that we use pypandoc, which seems to pull a ton of extra dependencies.

After looking at the code, pypandoc is only used to render restructuredtext readme files;

We should consider switching over to docutils (which is already in use for the apidoc generation) or to a more lightweight module such as https://github.com/pypa/readme_renderer, rather than keep this extra dependency.

Event Timeline

olasd triaged this task as Normal priority.Jan 23 2020, 4:35 PM
olasd created this task.

Indeed, this pypandoc dependency should be removed. Currently looking at the docutils internals to see how to use their rst to html convertor.

Turns out we already have that feature implemented in swh-web: https://forge.softwareheritage.org/source/swh-web/browse/master/swh/web/common/swh_templatetags.py$24-52

We should be able to easily adapt that code to remove the pypandoc dependency.