I would personally avoid relying on ^ version specs, especially since some of the docs packages don't do semver - mkdocs-material makes breaking changes randomly between major and minor bumps (I have been bit by it in the past), mkdocstrings is still at 0.x (so breaking changes happen in minors) etc.
The mkdocstrings griffe parser produces a lot of docstrings-related warnings, which forced me to remove strict mode in mkdocs builds. Would be good to fix those.
docs/requirements.txt
should be kept in sync with the versions used in thepyproject.toml
for poetry. In the apps cookiecutter we actually pin them down to a specific version since that's the only way to keep these two files in perfect sync (and tests!): https://github.com/nautobot/cookiecutter-nautobot-app/blob/develop/nautobot-app/%7B%7B%20cookiecutter.project_slug%20%7D%7D/pyproject.tomlI would personally avoid relying on
^
version specs, especially since some of the docs packages don't do semver - mkdocs-material makes breaking changes randomly between major and minor bumps (I have been bit by it in the past), mkdocstrings is still at 0.x (so breaking changes happen in minors) etc.The mkdocstrings griffe parser produces a lot of docstrings-related warnings, which forced me to remove strict mode in mkdocs builds. Would be good to fix those.