doc8

doc8 copied to clipboard

updates: - [github.com/psf/black: 22.6.0 → 22.8.0](https://github.com/psf/black/compare/22.6.0...22.8.0) - [github.com/pycqa/flake8: 5.0.3 → 5.0.4](https://github.com/pycqa/flake8/compare/5.0.3...5.0.4) - [github.com/PyCQA/pylint: v2.14.5 → v2.15.3](https://github.com/PyCQA/pylint/compare/v2.14.5...v2.15.3)

pre-commit-ci[bot]

Add more info on structuring config in pyproject.toml to the README

1

It would be useful to include some additional documentation about how to structure the config file when using `pyproject.toml`. I ran into some problems setting up the config file to...

RNKuhns

doc8 does not load ignore-path from pyproject.toml

4

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...

ssbarnea

false positive D004 Found literal carriage return

5

I get false positive > D004 Found literal carriage return at every line on Windows. It has been reported here first: https://bugs.launchpad.net/doc8/+bug/1756704

danieltuzes

Add --allow-long-tables option to permit wide RST tables

2

I often have very long tables that cannot be shortened and raise line-too-long doc8 errors. For example: ```rest ======================= ====================================================================================================== Header Description ======================= ====================================================================================================== Rather long header item My very...

lukelbd

Include directives like this are valid Sphinx: ```rst .. include:: /somefile.hrst ``` This is mentioned by the Sphinx developer [here](https://github.com/sphinx-doc/sphinx/issues/3508). The doc8 linter complains about the above definition though: ```...

SeanDS

doc8 fails when using `.. code-block:: none`, which in Sphinx is the documented way to turn off syntax highlighting. doc8 currently reports the error: > D000 Cannot analyze code. No...

robrap

Error in "code-block" directive: unknown option: "linenos".

3

Related to #26 ``` docs/index.rst:2: D000 Error in "code-block" directive: unknown option: "linenos". ``` The same for these options: * `linenos` * `lineno-start` * `caption` * `emphasize-lines` * `dedent` In...

jobec

I tried to use doc8 as a pre-commit hook but the checks that passed on my Mac were failing in Github CI. I even logged into the remote system using...

madhavajay

All directives are ignored for line-length check

2

Example: ```rst .. note:: This is an example not that should be too long for a single line and the linter should report it ``` IMO directive `code` should be...

mskrip