Skip private methods in Sphinx generated docs
I'm using sphinx to generate documentation for our Python API. Many functions in the Python API are actually SWIG wrapped C/C++/Fortran functions. I'd like the wrapped functions to appear in my API docs, but they don't have docstrings, so don't appear by default. I'm not interested in having private functions/methods/attributes appear in the docs, but they do when I supply the :undoc-members: directive.
How can I show only public names, including names of items with no docstring?
My best attempt at a configuration for a module:
.. automodule:: company.category.tool
:autodoc_member_order: bysource
:members:
:undoc-members:
:no-show-inheritance:
:no-private-members:
:no-ignore-module-all:
:exclude-members: this,thisown,acquire,disown,own
(The :no-ignore-module-all: is required because wrapped names are imported from a compiled library and listed in __all__. They are ignored otherwise) :no-private-members: seems to be ignored, unfortunately.
python swig python-sphinx
asked Nov 13 '18 at 17:32
dbndbn
6,95024374
add a comment |
I'm using sphinx to generate documentation for our Python API. Many functions in the Python API are actually SWIG wrapped C/C++/Fortran functions. I'd like the wrapped functions to appear in my API docs, but they don't have docstrings, so don't appear by default. I'm not interested in having private functions/methods/attributes appear in the docs, but they do when I supply the :undoc-members: directive.
How can I show only public names, including names of items with no docstring?
My best attempt at a configuration for a module:
.. automodule:: company.category.tool
:autodoc_member_order: bysource
:members:
:undoc-members:
:no-show-inheritance:
:no-private-members:
:no-ignore-module-all:
:exclude-members: this,thisown,acquire,disown,own
(The :no-ignore-module-all: is required because wrapped names are imported from a compiled library and listed in __all__. They are ignored otherwise) :no-private-members: seems to be ignored, unfortunately.
python swig python-sphinx
asked Nov 13 '18 at 17:32
dbndbn
6,95024374
add a comment |
I'm using sphinx to generate documentation for our Python API. Many functions in the Python API are actually SWIG wrapped C/C++/Fortran functions. I'd like the wrapped functions to appear in my API docs, but they don't have docstrings, so don't appear by default. I'm not interested in having private functions/methods/attributes appear in the docs, but they do when I supply the :undoc-members: directive.
How can I show only public names, including names of items with no docstring?
My best attempt at a configuration for a module:
.. automodule:: company.category.tool
:autodoc_member_order: bysource
:members:
:undoc-members:
:no-show-inheritance:
:no-private-members:
:no-ignore-module-all:
:exclude-members: this,thisown,acquire,disown,own
(The :no-ignore-module-all: is required because wrapped names are imported from a compiled library and listed in __all__. They are ignored otherwise) :no-private-members: seems to be ignored, unfortunately.
python swig python-sphinx
asked Nov 13 '18 at 17:32
dbndbn
6,95024374
I'm using sphinx to generate documentation for our Python API. Many functions in the Python API are actually SWIG wrapped C/C++/Fortran functions. I'd like the wrapped functions to appear in my API docs, but they don't have docstrings, so don't appear by default. I'm not interested in having private functions/methods/attributes appear in the docs, but they do when I supply the :undoc-members: directive.
How can I show only public names, including names of items with no docstring?
My best attempt at a configuration for a module:
.. automodule:: company.category.tool
:autodoc_member_order: bysource
:members:
:undoc-members:
:no-show-inheritance:
:no-private-members:
:no-ignore-module-all:
:exclude-members: this,thisown,acquire,disown,own
(The :no-ignore-module-all: is required because wrapped names are imported from a compiled library and listed in __all__. They are ignored otherwise) :no-private-members: seems to be ignored, unfortunately.
python swig python-sphinx
python swig python-sphinx
asked Nov 13 '18 at 17:32
dbndbn
6,95024374
asked Nov 13 '18 at 17:32
dbndbn
6,95024374
asked Nov 13 '18 at 17:32
dbndbn
6,95024374
asked Nov 13 '18 at 17:32
dbndbn
6,95024374
asked Nov 13 '18 at 17:32
dbndbn
6,95024374
6,95024374
add a comment |
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%2f53286592%2fskip-private-methods-in-sphinx-generated-docs%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.
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%2f53286592%2fskip-private-methods-in-sphinx-generated-docs%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
