Exclude `docs/conf.py` from linting

StatCan / datascience-cookiecutter

A Cookiecutter template for Data Science Projects in Python

MIT License

7 stars 1 forks source link

Exclude `docs/conf.py` from linting #69

Closed ToucheSir closed 10 months ago

ToucheSir commented 11 months ago

Ruff currently complains about docs/conf.py, but since this is auto-generated we should probably ignore it.

I ran into this while trying to use the template today. Alternatives could include loosening the set of rules we enforce or having more fine-grained exclusions under the docs folder.

goatsweater commented 10 months ago

Does it make sense to target only the conf.py file instead of the whole docs directory? Typically, conf.py is the only Python file in there so maybe not important?

ToucheSir commented 10 months ago

Good question. Let me test to see if targeting just that file works, and if so this PR can be more surgical.