Page MenuHomeSoftware Heritage

sphinx: use MyST for markdown rendering
ClosedPublic

Authored by zack on Sep 24 2020, 8:55 PM.

Details

Summary

This allows to have full support for all sphinx directives and link types.

Note: this diff also contains enabling the TODO extension, as it's a one liner,
but the changes will be commited separately.

Test Plan

tox -e sphinx-dev

Diff Detail

Repository
rDDOC Development documentation
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Why do we need markdown support in the docs?

Why do we need markdown support in the docs?

To be able to use hackmd/codimd to collaborate on doc that can then be integrated into the real doc without conversion.

But aside from that, we already have markdown document in our docs, they are not being introduced by this change. What this change does is enable to use actual sphinx stuff from those docs rather than being limited to prose and external links.

This revision is now accepted and ready to land.Sep 24 2020, 9:00 PM