search

astropy / sphinx-automodapi

Sphinx extension for generating API documentation
https://sphinx-automodapi.readthedocs.io
BSD 3-Clause "New" or "Revised" License
65 stars 45 forks source link

Spurious warning on configuring `nosignatures` #135

Closed simaoafonso-pwt closed 1 year ago

simaoafonso-pwt commented 3 years ago

Using something like this:

.. automodsumm:: MODULE
   :nosignatures:

Works as intended (signatures are not included), but produces this spurious warning:

.venv/lib/python3.8/site-packages/sphinx_automodapi/utils.py:179: UserWarning:    :nosignatures:
  warn(line)

https://github.com/astropy/sphinx-automodapi/blob/main/sphinx_automodapi/utils.py#L178-L180