rstcheck / rstcheck-core

Core library behind rstcheck.
http://rstcheck-core.rtfd.io/
MIT License
4 stars 8 forks source link

[Bug]: No directive `automodule` from `sphinx-apidoc` #62

Closed jamesbraza closed 1 year ago

jamesbraza commented 1 year ago

To Dos

Example Code (rst)

scripts package
===============

Submodules
----------

scripts.foo module
-------------------

.. automodule:: scripts.foo
   :members:
   :undoc-members:
   :show-inheritance:

Relevant log output

scripts.rst:10: (INFO/1) No directive entry for "automodule" in module "docutils.parsers.rst.languages.en".
scripts.rst:10: (ERROR/3) Unknown directive type "automodule".

Description

sphinx-apidoc fields don't appear to be recognized, how can this be solved?

Operating System

macOS

Operating System Details

No response

Python Version

3.11.4

rstcheck Version

These come from pip install rstcheck[sphinx]

Additional Context

No response

Cielquan commented 1 year ago

Currently rstcheck only supports standard rst and default sphinx directives. Therefore you would need to put automodule on the ignorelist for directives.

Example .rstcheck.cfg file:

[rstcheck]
ignore_directives = automodule

There is currently a feature request which aims to change this: https://github.com/rstcheck/rstcheck-core/issues/68