Skip to content

issues Search Results · repo:PyCQA/doc8 language:Python

Filter by

42 results
 (73 ms)

42 results

inPyCQA/doc8 (press backspace or delete to remove)

PyCQA/doc8
looking for maintainers

As I personally no longer use RST/Sphinx due to switch to mkdocs/markdown ecosystem, I want to handle the maintenance of doc8 to others that have a stronger connection to the system. While the project ...
help wanted
  • ssbarnea
  • Opened 
    5 days ago
  • #178

PyCQA/doc8
bullet list check (impovement proposal).

I am not sure if it is already supported, but it could be handy to support the check of this rule. EDIT: perhaps this use-case could be extended to all the cases that require some blank line.
  • ubaldot
  • Opened 
    on Nov 26, 2024
  • #175

PyCQA/doc8
Indirect reference targets fails to consider directive names

Using the following combination: .. |thing| replace:: *The Thing* .. _thing: `thing-code`_ .. literalinclude:: code.py :language: python :caption: Code about |thing| :name: thing-code See ...
  • fmigneault
  • Opened 
    on Oct 9, 2024
  • #171

PyCQA/doc8
Version 1.1.2 ignores long-line directive in setup.cfg

The following setup.cfg file reports long line errors on 1.1.2 but works properly on 1.1.1. What changed in 1.1.2 to mistakenly report these error messages? [doc8] ignore-path-errors=example-long-line-file.rst;D001 ...
  • gamesguru
  • Opened 
    on Sep 10, 2024
  • #168

PyCQA/doc8
ignore-path-errors does not like relative paths

Howdy, I have a lot of project repos using pre-commit which usually means using doc8 for readme files, etc. Normally it works fine, however, using it with a more complex document structure using include ...
bug
  • sarnold
  • 2
  • Opened 
    on Aug 30, 2024
  • #162

PyCQA/doc8
"extension" option and config parameter doesn't override defaults

I don t want to check .rst or .txt files, only .bar files. Given: $ ls foo.bar foo.baz foo.rst foo.txt running doc8 gives: $ doc8 -v -e .bar . Scanning... Selecting ./foo.bar ...
  • nega0
  • 1
  • Opened 
    on Apr 4, 2024
  • #157

PyCQA/doc8
Possible extension: checking Python docstrings are valid RST

I wanted to ask if this idea might be considered in scope for doc8: Parsing Python source code (*.py), extracting the docstrings, and validating those as RST. i.e. Something equivalent to the functionality ...
  • peterjc
  • Opened 
    on Mar 20, 2024
  • #156

PyCQA/doc8
`ignore-path-errors` does not work with a relative path

Given a project structure with: repo-root docs changes.rst where doc8 is executed from repo-root Either using --ignore-path-errors docs/changes.rst;D000 or setting ignore-path-errors = docs/changes.rst;D000, ...
  • fmigneault
  • Opened 
    on Aug 31, 2023
  • #147

PyCQA/doc8
doc8 ignores ''--config pyproject.toml" on Python 3.11

I have a number of reusable GitHub CI wokflows. One of them creates python environments of different versions and runs checks and tests. The doc8 command is common for any environment: doc8 --config pyproject.toml ...
  • SerGeRybakov
  • 7
  • Opened 
    on Aug 14, 2023
  • #145

PyCQA/doc8
pyproject.toml tool.doc8.extension extends the extensions default value rather than replace it

When invoking doc8 if no --extension value is provided in the command line argument, doc8 uses the defaults of [ .rst , .txt ] for this value, if the --extension command line argument is specified, its ...
  • dmg0345
  • Opened 
    on Jul 2, 2023
  • #143
Issue origami icon

Learn how you can use GitHub Issues to plan and track your work.

Save views for sprints, backlogs, teams, or releases. Rank, sort, and filter issues to suit the occasion. The possibilities are endless.Learn more about GitHub Issues
ProTip! 
Press the
/
key to activate the search input again and adjust your query.
Issue origami icon

Learn how you can use GitHub Issues to plan and track your work.

Save views for sprints, backlogs, teams, or releases. Rank, sort, and filter issues to suit the occasion. The possibilities are endless.Learn more about GitHub Issues
ProTip! 
Press the
/
key to activate the search input again and adjust your query.
Issue search results · GitHub