autodoc

来源： https://stackoverflow.com/questions/64588821/how-napoleon-and-autodoc-interact-documenting-members

来源： https://stackoverflow.com/questions/57610288/showing-only-private-methods-with-sphinx-autodoc

来源： https://stackoverflow.com/questions/57610288/showing-only-private-methods-with-sphinx-autodoc

来源： https://stackoverflow.com/questions/48368523/how-to-generate-sphinx-docks-in-nested-directory

来源： https://stackoverflow.com/questions/53668052/sphinx-cannot-find-my-python-files-says-no-module-named

来源： https://stackoverflow.com/questions/53668052/sphinx-cannot-find-my-python-files-says-no-module-named

来源： https://stackoverflow.com/questions/24864851/sphinx-autodoc-also-display-some-imported-function

问题 I'm documenting my library with Sphinx. And I have decorator logic_object : class logic_object: """Decorator for logic object class. """ def __init__(self, cls): self.cls = cls self.__doc__ = self.cls.__doc__ And I have gravity class that decorated by logic_object : @logic_object class gravity: """Basic gravity object logic class. :param float g: pixels of acceleration :param float jf: jump force """ #There is more not important code. My Sphinx .rst file is: Mind.Existence ===================

问题 How can I get the value of a constant into my Sphinx documentation? .. automodule:: mymodule :members: :private-members: This is my test module: class Test: """My Test Class""" __MY_TEST_CONSTANT = 98.2 """My test constant docu""" At the moment I get the description of my private constant but the value is "None" and not "98.2". class Test: My Test Class __MY_TEST_CONSTANT = None My test constant docu 回答1: I tested this and I'm pretty sure it's either: an undocumented feature, a bug, or both.

问题 How can I get the value of a constant into my Sphinx documentation? .. automodule:: mymodule :members: :private-members: This is my test module: class Test: """My Test Class""" __MY_TEST_CONSTANT = 98.2 """My test constant docu""" At the moment I get the description of my private constant but the value is "None" and not "98.2". class Test: My Test Class __MY_TEST_CONSTANT = None My test constant docu 回答1: I tested this and I'm pretty sure it's either: an undocumented feature, a bug, or both.