backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
83 stars 61 forks source link

Organize requirements.txt #92

Closed iamEAP closed 1 year ago

iamEAP commented 1 year ago

What / Why

Python dependencies are hard. Especially when the package you're publishing is sort of a weird hybrid between "library" (where one should not pin things!) and an end-product (where reproducibility is very important, and therefore one should definitely pin things).

This change doesn't actually change any of the resolved dependencies (as of today). But it attempts to organize things into logical groups:

  1. Dependencies that define compatible operating environments (e.g. mkdocs and markdown)
  2. Dependencies that we reflect back out as features of our own package (e.g. mdx sane lists)
  3. Dependencies that are like category 1, except they're only in place temporarily to work around an underlying python dependency issue. (We no longer have these, but we were carrying around a couple for a long time see #91 & #78)

So that we can more easily reason about dependency updates from renovate.