Skip to content

RTD documentation in v2.1.x uses outdated m2r2 python module in tests, tools and extras repositories #53

Description

@Anton-TF

Following the Read the Docs (RTD) migration to Python 3.12 and later, the m2r2 package is no longer available through a standard installation. This is due to several changes in the Python packaging ecosystem:

  • pkg_resources has been deprecated.
  • setuptools 82 removed pkg_resources.
  • Python virtual environments (venv) no longer install setuptools by default.

In addition m2r2 has been unmaintained for several years and is considered obsolete.

The recommended replacement is myst-parser. TF-M v2.3.0 migrated the documentation in all repositories from m2r2 to myst-parser. However, in the TF-M v2.1.5 LTS branch, only the main repository was updated. The tests, tools, and extras repositories still depend on m2r2, causing their documentation builds to fail on RTD with Python 3.12.

To restore documentation builds, the requirements.txt files in all TF-M v2.1.5 repositories should be updated to replace m2r2 with myst-parser.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions