Mixing
Is it possible to test if a method is a classmethod in a Sphinx autosummary template?
Currently, we have a methods autosummary table generated from this template (we set exclude methods above):
{% if methods %}
.. rubric:: Methods
.. autosummary::
{% for item in methods %}
{% if item not in exclude_methods %}
~{{ name }}.{{ item }}
{% endif %}
{%- endfor %}
{% endif %}
I'd like to break this into two sections, one with class methods and one with regular methods. The class methods are all alternative constructors.
Is there a way in the for loop to test if the {{ item }} is a classmethod? Or is there another way in the code that I can tag specific methods and then check for those tags in the template?
jinja2 python-sphinx autodoc
asked Nov 21 '18 at 15:28
jmilloyjmilloy
3,87153569
add a comment |
Currently, we have a methods autosummary table generated from this template (we set exclude methods above):
{% if methods %}
.. rubric:: Methods
.. autosummary::
{% for item in methods %}
{% if item not in exclude_methods %}
~{{ name }}.{{ item }}
{% endif %}
{%- endfor %}
{% endif %}
I'd like to break this into two sections, one with class methods and one with regular methods. The class methods are all alternative constructors.
Is there a way in the for loop to test if the {{ item }} is a classmethod? Or is there another way in the code that I can tag specific methods and then check for those tags in the template?
jinja2 python-sphinx autodoc
asked Nov 21 '18 at 15:28
jmilloyjmilloy
3,87153569
add a comment |
Currently, we have a methods autosummary table generated from this template (we set exclude methods above):
{% if methods %}
.. rubric:: Methods
.. autosummary::
{% for item in methods %}
{% if item not in exclude_methods %}
~{{ name }}.{{ item }}
{% endif %}
{%- endfor %}
{% endif %}
I'd like to break this into two sections, one with class methods and one with regular methods. The class methods are all alternative constructors.
Is there a way in the for loop to test if the {{ item }} is a classmethod? Or is there another way in the code that I can tag specific methods and then check for those tags in the template?
jinja2 python-sphinx autodoc
asked Nov 21 '18 at 15:28
jmilloyjmilloy
3,87153569
Currently, we have a methods autosummary table generated from this template (we set exclude methods above):
{% if methods %}
.. rubric:: Methods
.. autosummary::
{% for item in methods %}
{% if item not in exclude_methods %}
~{{ name }}.{{ item }}
{% endif %}
{%- endfor %}
{% endif %}
I'd like to break this into two sections, one with class methods and one with regular methods. The class methods are all alternative constructors.
Is there a way in the for loop to test if the {{ item }} is a classmethod? Or is there another way in the code that I can tag specific methods and then check for those tags in the template?
jinja2 python-sphinx autodoc
jinja2 python-sphinx autodoc
asked Nov 21 '18 at 15:28
jmilloyjmilloy
3,87153569
asked Nov 21 '18 at 15:28
jmilloyjmilloy
3,87153569
asked Nov 21 '18 at 15:28
jmilloyjmilloy
3,87153569
asked Nov 21 '18 at 15:28
jmilloyjmilloy
3,87153569
asked Nov 21 '18 at 15:28
jmilloyjmilloy
3,87153569
3,87153569
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%2f53415350%2fis-it-possible-to-test-if-a-method-is-a-classmethod-in-a-sphinx-autosummary-temp%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%2f53415350%2fis-it-possible-to-test-if-a-method-is-a-classmethod-in-a-sphinx-autosummary-temp%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
