Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Strict Requirement pinnings #45

Closed
dmaljovec opened this issue Nov 14, 2021 · 4 comments
Closed

Strict Requirement pinnings #45

dmaljovec opened this issue Nov 14, 2021 · 4 comments

Comments

@dmaljovec
Copy link

Great work on this project!

I am wondering if the requirement pins in your dependency chain are all hard requirements? We are trying to use mkdocstrings in conjunction with this package for a Python 3.9 application and are getting a conflict on Markdown stemming from here: https://github.com/backstage/mkdocs-techdocs-core/blob/main/requirements.txt#L12. Is it true that you are not currently supporting latter versions of the Markdown package? Or was this possibly an overly conservative pinning?

@dmaljovec
Copy link
Author

For example, we use pip-compile to generate lockfiles for all of our requirements, and we are getting breakage in the following use case:

docs.in (input file)

mkdocs
mkdocs-material
mkdocstrings
mkdocs-gen-files
mkdocs-literate-nav
mkdocs-section-index
mkdocs-techdocs-core
pytkdocs[numpy-style]

pip-compile --pip-args='--no-input' docs.in (command to generate a documentation lockfile)

...
There are incompatible versions in the resolved dependencies:
  Markdown<4.0,>=3.3 (from mkdocstrings==0.15.2->-r docs.in (...))
  Markdown==3.2.2 (from mkdocs-techdocs-core==0.2.1->-r docs.in (...))
  markdown>=3.2 (from mkdocs-material==7.3.6->-r docs.in (...))
  Markdown>=3.2.1 (from mkdocs==1.2.3->-r docs.in (...))

@dmaljovec
Copy link
Author

FWIW, if I pip install mkdocs-tech-docs first and then install the rest of these requirements, pip complains that my Markdown is incompatible, but I am able to run techdocs-cli generate --no-docker or mkdocs build without error. Perhaps, I am not exercising the incompatible features?

@iamEAP
Copy link
Member

iamEAP commented Nov 19, 2021

Hey there! Yeah, looks like the strict pinning is coming from a problem with planuml (check out #37 for details).

Happy to loosen that restriction if we can prevent the issue described.

@iamEAP
Copy link
Member

iamEAP commented Aug 3, 2022

Closing this out now, as our dependency on markdown has been loosened!

@iamEAP iamEAP closed this as completed Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants