Using Sphinx methods inside auto generated docstrings
I am starting to get acquainted with Sphinx as a code documentation generator. It makes that clumsy process more fluent, I still have some doubts of how to do stuff properly with that tool, though.
What I am trying to achieve right now is ie. placing a link to some function within my docstring. Ie.
List of all emergency numbers in Poland (used in is_foreign() method)
and I would like to set a link to that method, so when somebody click on it, a doc for that method will be displayed. I know you can do such stuff with .rst files but.. In case where my .rst file is mostly auto-generated how do I handle such stuff? I am not talking only about that link-case but anything such as inserting an image inside certain method etc.
Is the only way to handle it is to manually create an entry of each method which needs for special treatment? If so: how do I exclude it from autogenerating?
Thanks in advance for any tips and tricks.
python-3.x python-sphinx
edited Nov 21 '18 at 15:42
barryhunter
19.2k22335
asked Nov 21 '18 at 14:13
hikamarehikamare
799
add a comment |
I am starting to get acquainted with Sphinx as a code documentation generator. It makes that clumsy process more fluent, I still have some doubts of how to do stuff properly with that tool, though.
What I am trying to achieve right now is ie. placing a link to some function within my docstring. Ie.
List of all emergency numbers in Poland (used in is_foreign() method)
and I would like to set a link to that method, so when somebody click on it, a doc for that method will be displayed. I know you can do such stuff with .rst files but.. In case where my .rst file is mostly auto-generated how do I handle such stuff? I am not talking only about that link-case but anything such as inserting an image inside certain method etc.
Is the only way to handle it is to manually create an entry of each method which needs for special treatment? If so: how do I exclude it from autogenerating?
Thanks in advance for any tips and tricks.
python-3.x python-sphinx
edited Nov 21 '18 at 15:42
barryhunter
19.2k22335
asked Nov 21 '18 at 14:13
hikamarehikamare
799
You can use cross-reference markup such as:meth:`is_foreign`in docstrings. See stackoverflow.com/a/22714510/407651.
– mzjn
Nov 21 '18 at 16:06
add a comment |
I am starting to get acquainted with Sphinx as a code documentation generator. It makes that clumsy process more fluent, I still have some doubts of how to do stuff properly with that tool, though.
What I am trying to achieve right now is ie. placing a link to some function within my docstring. Ie.
List of all emergency numbers in Poland (used in is_foreign() method)
and I would like to set a link to that method, so when somebody click on it, a doc for that method will be displayed. I know you can do such stuff with .rst files but.. In case where my .rst file is mostly auto-generated how do I handle such stuff? I am not talking only about that link-case but anything such as inserting an image inside certain method etc.
Is the only way to handle it is to manually create an entry of each method which needs for special treatment? If so: how do I exclude it from autogenerating?
Thanks in advance for any tips and tricks.
python-3.x python-sphinx
edited Nov 21 '18 at 15:42
barryhunter
19.2k22335
asked Nov 21 '18 at 14:13
hikamarehikamare
799
I am starting to get acquainted with Sphinx as a code documentation generator. It makes that clumsy process more fluent, I still have some doubts of how to do stuff properly with that tool, though.
What I am trying to achieve right now is ie. placing a link to some function within my docstring. Ie.
List of all emergency numbers in Poland (used in is_foreign() method)
and I would like to set a link to that method, so when somebody click on it, a doc for that method will be displayed. I know you can do such stuff with .rst files but.. In case where my .rst file is mostly auto-generated how do I handle such stuff? I am not talking only about that link-case but anything such as inserting an image inside certain method etc.
Is the only way to handle it is to manually create an entry of each method which needs for special treatment? If so: how do I exclude it from autogenerating?
Thanks in advance for any tips and tricks.
python-3.x python-sphinx
python-3.x python-sphinx
edited Nov 21 '18 at 15:42
barryhunter
19.2k22335
asked Nov 21 '18 at 14:13
hikamarehikamare
799
edited Nov 21 '18 at 15:42
barryhunter
19.2k22335
asked Nov 21 '18 at 14:13
hikamarehikamare
799
edited Nov 21 '18 at 15:42
barryhunter
19.2k22335
edited Nov 21 '18 at 15:42
barryhunter
19.2k22335
edited Nov 21 '18 at 15:42
barryhunter
19.2k22335
19.2k22335
asked Nov 21 '18 at 14:13
hikamarehikamare
799
asked Nov 21 '18 at 14:13
hikamarehikamare
799
asked Nov 21 '18 at 14:13
hikamarehikamare
799
799
You can use cross-reference markup such as:meth:`is_foreign`in docstrings. See stackoverflow.com/a/22714510/407651.
– mzjn
Nov 21 '18 at 16:06
add a comment |
You can use cross-reference markup such as:meth:`is_foreign`in docstrings. See stackoverflow.com/a/22714510/407651.
– mzjn
Nov 21 '18 at 16:06
You can use cross-reference markup such as
:meth:`is_foreign` in docstrings. See stackoverflow.com/a/22714510/407651.– mzjn
Nov 21 '18 at 16:06
You can use cross-reference markup such as
:meth:`is_foreign` in docstrings. See stackoverflow.com/a/22714510/407651.– mzjn
Nov 21 '18 at 16:06
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%2f53413995%2fusing-sphinx-methods-inside-auto-generated-docstrings%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%2f53413995%2fusing-sphinx-methods-inside-auto-generated-docstrings%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
You can use cross-reference markup such as
:meth:`is_foreign`in docstrings. See stackoverflow.com/a/22714510/407651.– mzjn
Nov 21 '18 at 16:06