Open
Description
Hi there,
I'm wondering what the best way forward is for my use case. I currently make use of the module-level docstrings to supply the documentation on my project's ReadTheDocs page. This can include adding sections that are not in the standard.
Ignoring GL06
/Unknown Section
should be enough to handle this, but I still end up with many UserWarning
messages when running the tool, e.g.
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Calendar Handling Utilities
self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Cf-convention Checking
self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Data Checks
self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Data Flags
self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Formatting Utilities For Indicators
self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Indicator Utilities
self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Dictionary And Yaml Parser
self[section] = content
...
It would be great if ignoring GL06
would also prevent these UserWarning
s from being emitted.
Metadata
Metadata
Assignees
Labels
No labels