How can I generate a Class index in sphinx?
I am using the autodoc extension to have my sphinx doc generated from the docstrings, like this:
.. contents::
ikkuna.export.subscriber
========================
Module contents
---------------
.. automodule:: ikkuna.export.subscriber
:members:
:undoc-members:
Now I would like to have an index (a list) of all classes in a module, so the viewer doesn't need to perform linear search to find the class they want. This seems rather basic, but I can't seem to find how to do this.
If it's not possible to do it on a per-document basis, I'd settle for a global class index.
python-3.x python-sphinx autodoc
asked Nov 23 '18 at 14:19
oarfishoarfish
1,36121740
add a comment |
I am using the autodoc extension to have my sphinx doc generated from the docstrings, like this:
.. contents::
ikkuna.export.subscriber
========================
Module contents
---------------
.. automodule:: ikkuna.export.subscriber
:members:
:undoc-members:
Now I would like to have an index (a list) of all classes in a module, so the viewer doesn't need to perform linear search to find the class they want. This seems rather basic, but I can't seem to find how to do this.
If it's not possible to do it on a per-document basis, I'd settle for a global class index.
python-3.x python-sphinx autodoc
asked Nov 23 '18 at 14:19
oarfishoarfish
1,36121740
See the comments on this similar question: stackoverflow.com/q/53371146/407651
– mzjn
Nov 23 '18 at 15:33
add a comment |
I am using the autodoc extension to have my sphinx doc generated from the docstrings, like this:
.. contents::
ikkuna.export.subscriber
========================
Module contents
---------------
.. automodule:: ikkuna.export.subscriber
:members:
:undoc-members:
Now I would like to have an index (a list) of all classes in a module, so the viewer doesn't need to perform linear search to find the class they want. This seems rather basic, but I can't seem to find how to do this.
If it's not possible to do it on a per-document basis, I'd settle for a global class index.
python-3.x python-sphinx autodoc
asked Nov 23 '18 at 14:19
oarfishoarfish
1,36121740
I am using the autodoc extension to have my sphinx doc generated from the docstrings, like this:
.. contents::
ikkuna.export.subscriber
========================
Module contents
---------------
.. automodule:: ikkuna.export.subscriber
:members:
:undoc-members:
Now I would like to have an index (a list) of all classes in a module, so the viewer doesn't need to perform linear search to find the class they want. This seems rather basic, but I can't seem to find how to do this.
If it's not possible to do it on a per-document basis, I'd settle for a global class index.
python-3.x python-sphinx autodoc
python-3.x python-sphinx autodoc
asked Nov 23 '18 at 14:19
oarfishoarfish
1,36121740
asked Nov 23 '18 at 14:19
oarfishoarfish
1,36121740
asked Nov 23 '18 at 14:19
oarfishoarfish
1,36121740
asked Nov 23 '18 at 14:19
oarfishoarfish
1,36121740
asked Nov 23 '18 at 14:19
oarfishoarfish
1,36121740
1,36121740
See the comments on this similar question: stackoverflow.com/q/53371146/407651
– mzjn
Nov 23 '18 at 15:33
add a comment |
See the comments on this similar question: stackoverflow.com/q/53371146/407651
– mzjn
Nov 23 '18 at 15:33
See the comments on this similar question: stackoverflow.com/q/53371146/407651
– mzjn
Nov 23 '18 at 15:33
See the comments on this similar question: stackoverflow.com/q/53371146/407651
– mzjn
Nov 23 '18 at 15:33
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%2f53448368%2fhow-can-i-generate-a-class-index-in-sphinx%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%2f53448368%2fhow-can-i-generate-a-class-index-in-sphinx%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
See the comments on this similar question: stackoverflow.com/q/53371146/407651
– mzjn
Nov 23 '18 at 15:33