Questions about sphinx-napoleon
Read more about sphinx-napoleon
python (65.1k questions)
javascript (44.2k questions)
reactjs (22.7k questions)
java (20.8k questions)
c# (17.4k questions)
html (16.3k questions)
r (13.7k questions)
android (12.9k questions)
Sphinx-autodoc with napoleon (Google Doc String Style): Warnings and Errors about Block quotes and indention
I am using Sphinx 4.4.0 with napoleon extension (Google Doc String). I have this two problems
ARNING: Block quote ends without a blank line; unexpected unindent.
ERROR: Unexpected indentation.
I fou...
buhtz
Votes: 0
Answers: 1
Sphinx autodoc/napoleon doesn't generate docstrings
I'm doing a really simple example and can't get it to work. I just have one file, simulator.py that I added numpy style docstrings to. It does not import any other libraries. It has an __init__ and I ...
Katie
Votes: 0
Answers: 1
Variable format changed to ~class.attribute in docs
So I've been working on some docs for some weeks now and they always appeared fine until last night all the variables started coming up in the format ~Class.Attribute. I attempted to rollback to multi...
Sohjiro
Votes: 0
Answers: 1
Sphinx remove dataclass fields from autodoc
As this post describes, autodoc will eagerly add the class variables to the documentation even if napoleon adds the fields as documentation in:
from dataclasses import dataclass
@dataclass
class Foo()...
OneRaynyDay
Votes: 0
Answers: 1