Doc8 rejecting a linenos attribute we need as a directive in openstackdoctools RST/Sphinx theme
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
doc8 |
Invalid
|
Undecided
|
Anne Gentle |
Bug Description
We need to use a linenos directive built into Sphinx to get line number output for our HTML with the new openstackdocstheme.
https:/
We've found that the doc8 does not recognize this flag on the highlight directive. http://
Excerpt from:
http://
2015-02-26 00:35:42.145 | checkniceness runtests: commands[1] | doc8 doc
2015-02-26 00:35:42.148 | /home/jenkins/
2015-02-26 00:35:47.429 | Scanning...
2015-02-26 00:35:47.429 | Validating...
2015-02-26 00:35:47.429 | doc/networking-
2015-02-26 00:35:47.429 | unknown option: "linenos".
2015-02-26 00:35:47.429 | doc/networking-
2015-02-26 00:35:47.429 | unknown option: "linenos".
2015-02-26 00:35:47.429 | doc/networking-
2015-02-26 00:35:47.429 | unknown option: "linenos".
2015-02-26 00:35:47.429 | doc/networking-
2015-02-26 00:35:47.430 | unknown option: "linenos".
2015-02-26 00:35:47.430 | doc/networking-
2015-02-26 00:35:47.430 | unknown option: "linenos".
2015-02-26 00:35:47.430 | doc/networking-
2015-02-26 00:35:47.430 | unknown option: "linenos".
2015-02-26 00:35:47.430 | doc/networking-
2015-02-26 00:35:47.430 | unknown option: "linenos".
2015-02-26 00:35:47.430 | doc/networking-
2015-02-26 00:35:47.430 | unknown option: "linenos".
2015-02-26 00:35:47.430 | doc/networking-
2015-02-26 00:35:47.430 | unknown option: "linenos".
2015-02-26 00:35:47.431 | doc/networking-
2015-02-26 00:35:47.431 | unknown option: "linenos".
2015-02-26 00:35:47.431 | ========
2015-02-26 00:35:47.431 | Total files scanned = 53
2015-02-26 00:35:47.431 | Total files ignored = 0
2015-02-26 00:35:47.431 | Total accumulated errors = 10
2015-02-26 00:35:47.431 | Detailed error counts:
2015-02-26 00:35:47.431 | - doc8.checks.
2015-02-26 00:35:47.431 | - doc8.checks.
2015-02-26 00:35:47.431 | - doc8.checks.
2015-02-26 00:35:47.431 | - doc8.checks.
2015-02-26 00:35:47.432 | - doc8.checks.
2015-02-26 00:35:47.432 | - doc8.checks.
2015-02-26 00:35:47.454 | ERROR: InvocationError: '/home/
2015-02-26 00:35:47.454 | checkniceness runtests: commands[2] | flake8
2015-02-26 00:35:47.457 | /home/jenkins/
2015-02-26 00:35:47.963 | _______
2015-02-26 00:35:47.963 | ERROR: checkniceness: commands failed
Changed in doc8: | |
status: | New → Confirmed |
assignee: | nobody → Anne Gentle (annegentle) |
Changed in doc8: | |
status: | In Progress → Invalid |
So this appears to be a problem with restructuredtex t-lint [1]. Since `:linenos:` is a sphinx-specific directive, we either need to update restructuredtex t-lint to handle sphinx directives and options /or/ add a specific expression to ignore this particular warning in main (like the default excludes [2]).
[1]: https:/ /github. com/twolfson/ restructuredtex t-lint
[2]: https:/ /github. com/stackforge/ doc8/blob/ master/ doc8/checks. py#L100. .L105