search

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
85 stars 61 forks source link

Remove duplicated dependencies list #19

Closed OrkoHunter closed 3 years ago

OrkoHunter commented 3 years ago

We have listed Python dependencies in two places for this project

  1. https://github.com/backstage/mkdocs-techdocs-core/blob/main/requirements.txt
  2. install_requires in https://github.com/backstage/mkdocs-techdocs-core/blob/main/setup.py

This can cause inconsistencies when upgrading versions (like https://github.com/backstage/mkdocs-techdocs-core/pull/18). So we should keep just one - possibly reuse data from requirements.txt in install_requires of setup.py.

iamansoni commented 3 years ago

I would like to work on this task; you can assign it to me. Also, will it be a good solution if I make requirements.txt to be read as a file in the setup.py and pass it as a list of strings to install_requires ?

OrkoHunter commented 3 years ago

Sounds good to me. @iamansoni