doc8
doc8 copied to clipboard
doc8 does not load ignore-path from pyproject.toml
I tried used two versions of what it was supposed to be config in toml file and I observed that running doc8
failed to use the ignore. On the other hand putting configuration inside setup.cfg
worked.
case 1
# pyproject.toml
[tool.doc8]
ignore-path = [".tox"]
case 2
# pyproject.toml
[tool.doc8]
ignore-path = ".tox"
None of these works and based on docs, at least should have worked.
I found that the following does work in pyproject.toml
when using doc8 0.11.1 with tomli installed:
[tool.doc8]
ignore_path = ["docs/build"]
argparse.ArgumentParser
replaces hyphens in argument names with underscores. When doc8 loads an INI file, it renames the options to match the names returned by argparse and doc8 uses the underscore names internally. I'm guessing it's a bug that doc8 does not also normalize option names when they are loaded from pyproject.toml
.
A patch would be welcomed.
See #85
This issue is now resolved.