timothycrosley / portray

Your Project with Great Documentation.
MIT License
861 stars 74 forks source link

FIx issue 83 #84

Closed myedibleenso closed 3 years ago

myedibleenso commented 3 years ago

This is a mkdocs compatibility fix pointed out by @Peter200lx .

To help avoid surprises like this, I was wondering if it would make sense to pin an exact version of mkdocs (and others). Currently, only a major version is specified:

https://github.com/timothycrosley/portray/blob/371ab8bce9ebd0ba6b77bc5e8c1d318a0e3aa428/pyproject.toml#L12

Peter200lx commented 3 years ago

This change requires at least mkdocs of "^1.2" given that mkdocs.config.defaults.get_schema() doesn't exist before 1.2: https://github.com/mkdocs/mkdocs/blob/1.2.0/mkdocs/config/defaults.py#L12

def get_schema():
    return (

https://github.com/mkdocs/mkdocs/blob/1.1.2/mkdocs/config/defaults.py#L11

DEFAULT_SCHEMA = (

However in general given the fact that mkdocs has shown willingness in #83 to have breaking changes at a minor dot release, we should probably pin to that level:

mkdocs = "~1.2"

https://python-poetry.org/docs/dependency-specification/#tilde-requirements

myedibleenso commented 3 years ago

Thanks, @Peter200lx .

timothycrosley commented 3 years ago

This looks good to me! Thanks for fixing this @myedibleenso and @Peter200lx! I think CI is just failing because the requirements file needs to be re-locked, so I'm going to merge and then immediately address the CI failures