Sphinx extension to support docstrings in Numpy format
{
"context": "Evaluates whether the solution relies on numpydoc to parse NumPy-style docstrings for callables, classes, and raw text, renders RST previews via the package renderer, and passes through relevant configuration while saving the rendered output.",
"type": "weighted_checklist",
"checklist": [
{
"name": "Doc parser",
"description": "Uses numpydoc.NumpyDocString or numpydoc.docscrape.FunctionDoc/ClassDoc to parse NumPy-style sections for callables and classes instead of manual string parsing.",
"max_score": 30
},
{
"name": "RST renderer",
"description": "Generates the preview text through numpydoc.docscrape_sphinx.SphinxDocString (or equivalent renderer) so section headers, fields, and formatting come from numpydoc rather than custom string assembly.",
"max_score": 30
},
{
"name": "Object handling",
"description": "Supplies real callables/classes to numpydoc (e.g., via FunctionDoc/ClassDoc) so Parameters/Returns/Attributes sections in the RST derive from the inspected object docstrings, not hardcoded templates.",
"max_score": 15
},
{
"name": "Raw text path",
"description": "Routes raw docstring strings through numpydoc (e.g., NumpyDocString with an object name) to keep See Also and Examples formatting, avoiding manual reStructuredText recreation.",
"max_score": 15
},
{
"name": "Config passthrough",
"description": "Forwards provided config mappings into the numpydoc parser/renderer (such as SphinxDocString options or constructor kwargs) so output reflects caller overrides rather than fixed defaults.",
"max_score": 10
}
]
}tessl i tessl/pypi-numpydoc@1.9.0evals
scenario-1
scenario-2
scenario-3
scenario-4
scenario-5
scenario-6
scenario-7
scenario-8
scenario-9