Sphinx autodoc including classes and methods
I have python classes and some of them are in their own files
i.e. userdata.py:
class userdata:
"""User input class for reading..."""
def __init__(self, fname):
self.fname = fname
def trykey(self,name,injson):
....
I have tried multiple methods to be able to refer to a specific method in that class in the documentation, but it did not work.
I am generating autodoc via command
sphinx-apidoc
It only generates modules for the code above
_lib.io package
=====================
Submodules
----------
.. toctree::
lib.io.userdata
Module contents
---------------
.. automodule:: lib.io
:members:
:undoc-members:
:show-inheritance:
Similar problem for modules with multiple classes
i.e. ad1.py
class inner1(inherited)
....
class inner2(inherited)
....def
....
autodoc:
_lib.ad.ad1 module
===========================================
.. automodule:: lib.ad.ad1
:members:
:undoc-members:
:show-inheritance:
Is there a way to get autoclass and automethod automatically generated as well.
python python-sphinx autodoc sphinx-apidoc
edited Nov 18 '18 at 8:25
mzjn
31.4k666154
asked Nov 18 '18 at 8:22
user2375049user2375049
84111
add a comment |
I have python classes and some of them are in their own files
i.e. userdata.py:
class userdata:
"""User input class for reading..."""
def __init__(self, fname):
self.fname = fname
def trykey(self,name,injson):
....
I have tried multiple methods to be able to refer to a specific method in that class in the documentation, but it did not work.
I am generating autodoc via command
sphinx-apidoc
It only generates modules for the code above
_lib.io package
=====================
Submodules
----------
.. toctree::
lib.io.userdata
Module contents
---------------
.. automodule:: lib.io
:members:
:undoc-members:
:show-inheritance:
Similar problem for modules with multiple classes
i.e. ad1.py
class inner1(inherited)
....
class inner2(inherited)
....def
....
autodoc:
_lib.ad.ad1 module
===========================================
.. automodule:: lib.ad.ad1
:members:
:undoc-members:
:show-inheritance:
Is there a way to get autoclass and automethod automatically generated as well.
python python-sphinx autodoc sphinx-apidoc
edited Nov 18 '18 at 8:25
mzjn
31.4k666154
asked Nov 18 '18 at 8:22
user2375049user2375049
84111
Note that sphinx-apidoc only generatesautomoduledirectives. If you want to useautoclassorautofunction, you have to add these directives by hand. In order to understand exactly what your problem is, we need more details (preferably in the form of a Minimal, Complete, and Verifiable example).
– mzjn
Nov 18 '18 at 8:42
ok then the answer is no as far as i understand. thank you
– user2375049
Nov 18 '18 at 8:55
You don't have to useautoclassorautomethod. Using onlyautomoduleshould work.
– mzjn
Nov 18 '18 at 15:49
add a comment |
I have python classes and some of them are in their own files
i.e. userdata.py:
class userdata:
"""User input class for reading..."""
def __init__(self, fname):
self.fname = fname
def trykey(self,name,injson):
....
I have tried multiple methods to be able to refer to a specific method in that class in the documentation, but it did not work.
I am generating autodoc via command
sphinx-apidoc
It only generates modules for the code above
_lib.io package
=====================
Submodules
----------
.. toctree::
lib.io.userdata
Module contents
---------------
.. automodule:: lib.io
:members:
:undoc-members:
:show-inheritance:
Similar problem for modules with multiple classes
i.e. ad1.py
class inner1(inherited)
....
class inner2(inherited)
....def
....
autodoc:
_lib.ad.ad1 module
===========================================
.. automodule:: lib.ad.ad1
:members:
:undoc-members:
:show-inheritance:
Is there a way to get autoclass and automethod automatically generated as well.
python python-sphinx autodoc sphinx-apidoc
edited Nov 18 '18 at 8:25
mzjn
31.4k666154
asked Nov 18 '18 at 8:22
user2375049user2375049
84111
I have python classes and some of them are in their own files
i.e. userdata.py:
class userdata:
"""User input class for reading..."""
def __init__(self, fname):
self.fname = fname
def trykey(self,name,injson):
....
I have tried multiple methods to be able to refer to a specific method in that class in the documentation, but it did not work.
I am generating autodoc via command
sphinx-apidoc
It only generates modules for the code above
_lib.io package
=====================
Submodules
----------
.. toctree::
lib.io.userdata
Module contents
---------------
.. automodule:: lib.io
:members:
:undoc-members:
:show-inheritance:
Similar problem for modules with multiple classes
i.e. ad1.py
class inner1(inherited)
....
class inner2(inherited)
....def
....
autodoc:
_lib.ad.ad1 module
===========================================
.. automodule:: lib.ad.ad1
:members:
:undoc-members:
:show-inheritance:
Is there a way to get autoclass and automethod automatically generated as well.
python python-sphinx autodoc sphinx-apidoc
python python-sphinx autodoc sphinx-apidoc
edited Nov 18 '18 at 8:25
mzjn
31.4k666154
asked Nov 18 '18 at 8:22
user2375049user2375049
84111
edited Nov 18 '18 at 8:25
mzjn
31.4k666154
asked Nov 18 '18 at 8:22
user2375049user2375049
84111
edited Nov 18 '18 at 8:25
mzjn
31.4k666154
edited Nov 18 '18 at 8:25
mzjn
31.4k666154
edited Nov 18 '18 at 8:25
mzjn
31.4k666154
31.4k666154
asked Nov 18 '18 at 8:22
user2375049user2375049
84111
asked Nov 18 '18 at 8:22
user2375049user2375049
84111
asked Nov 18 '18 at 8:22
user2375049user2375049
84111
84111
Note that sphinx-apidoc only generatesautomoduledirectives. If you want to useautoclassorautofunction, you have to add these directives by hand. In order to understand exactly what your problem is, we need more details (preferably in the form of a Minimal, Complete, and Verifiable example).
– mzjn
Nov 18 '18 at 8:42
ok then the answer is no as far as i understand. thank you
– user2375049
Nov 18 '18 at 8:55
You don't have to useautoclassorautomethod. Using onlyautomoduleshould work.
– mzjn
Nov 18 '18 at 15:49
add a comment |
Note that sphinx-apidoc only generatesautomoduledirectives. If you want to useautoclassorautofunction, you have to add these directives by hand. In order to understand exactly what your problem is, we need more details (preferably in the form of a Minimal, Complete, and Verifiable example).
– mzjn
Nov 18 '18 at 8:42
ok then the answer is no as far as i understand. thank you
– user2375049
Nov 18 '18 at 8:55
You don't have to useautoclassorautomethod. Using onlyautomoduleshould work.
– mzjn
Nov 18 '18 at 15:49
Note that sphinx-apidoc only generates
automodule directives. If you want to use autoclass or autofunction, you have to add these directives by hand. In order to understand exactly what your problem is, we need more details (preferably in the form of a Minimal, Complete, and Verifiable example).– mzjn
Nov 18 '18 at 8:42
Note that sphinx-apidoc only generates
automodule directives. If you want to use autoclass or autofunction, you have to add these directives by hand. In order to understand exactly what your problem is, we need more details (preferably in the form of a Minimal, Complete, and Verifiable example).– mzjn
Nov 18 '18 at 8:42
ok then the answer is no as far as i understand. thank you
– user2375049
Nov 18 '18 at 8:55
ok then the answer is no as far as i understand. thank you
– user2375049
Nov 18 '18 at 8:55
You don't have to use
autoclass or automethod. Using only automodule should work.– mzjn
Nov 18 '18 at 15:49
You don't have to use
autoclass or automethod. Using only automodule should work.– mzjn
Nov 18 '18 at 15:49
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53359058%2fsphinx-autodoc-including-classes-and-methods%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Some of your past answers have not been well-received, and you're in danger of being blocked from answering.
Please pay close attention to the following guidance:
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53359058%2fsphinx-autodoc-including-classes-and-methods%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Note that sphinx-apidoc only generates
automoduledirectives. If you want to useautoclassorautofunction, you have to add these directives by hand. In order to understand exactly what your problem is, we need more details (preferably in the form of a Minimal, Complete, and Verifiable example).– mzjn
Nov 18 '18 at 8:42
ok then the answer is no as far as i understand. thank you
– user2375049
Nov 18 '18 at 8:55
You don't have to use
autoclassorautomethod. Using onlyautomoduleshould work.– mzjn
Nov 18 '18 at 15:49