numpydoc
numpydoc copied to clipboard
numpy
Numpy's Sphinx extensions
Found a potential bug. I'm noticing the following pattern for excluding a method as shown in docs is generating a malformed toml error: ```toml exclude = [ "\.__init__$", ] ```...
Excellent work on implementing the numpydoc validation as a pre-commit hook. I've noticed that it is flagging getters and sellers. For example: ```py @property def x(self) -> np.ndarray: """Return or...
I'm wondering how to porperly document property getters and setters. Until now, I've been documenting everything in the getter, leaving the setter without docstring. That way, the generated HTML documentation...
When getting error messages it does not provide information about the file causing the error ``` compilando [html]: todos los archivos fuente actualizando ambiente: [nueva configuración] 12añadido, 0 cambiado, 0...
#### Context I need type annotations and this project doesn't support this yet (#196, #356)- I tested out successfully _sphinx.ext.napoleon_, but that project doesn't provide a validator (crazy, right?), so...
I have a couple warnings that I don't understand, also because I am doing already what the validator says... ```python SOME_CONSTANT = 1 """ summary line. some explanation. """ ```...
From the docs it is not clear if this is possible and my first tries failed. If I do ``python -m numpydoc -h``I see, ``` Implementing `python -m numpydoc` functionality....
See https://github.com/numpy/numpydoc/pull/454 `python -m numpydoc` `python -m numpydoc.hooks.validate_docstrings` These CLI interfaces do slightly different things, but one could imagine a command word interface a-la git. Also, it would be good...
Hello, I'm maintaining a tool called [Griffe](https://github.com/mkdocstrings/griffe) which among other things is capable of parsing Numpydoc styled docstrings. It's used by [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings), to auto-generate HTML docs from Python source code...
While testing #454 I noticed that for the following docstring, ``` """Bad, bad docstring! Parameters --------- x : `int` y: Another variable. Returns ------- z : `int` The sum of...