Use an attribute value as docstring
0
I have class called Foo:
class Foo:
bar = X()
bar.description = 'My description of bar.'
foo.bar has an attribute describing it, as if it were its docstring. This happens to the majority of my attributes in Foo.
Is there a way I can ask sphinx to try to use the .description string to document bar?
Thank you in advance.
python python-sphinx
edited Nov 12 '18 at 16:57
mzjn
31.4k666154
asked Nov 12 '18 at 16:42
bustawin
726
add a comment |
0
I have class called Foo:
class Foo:
bar = X()
bar.description = 'My description of bar.'
foo.bar has an attribute describing it, as if it were its docstring. This happens to the majority of my attributes in Foo.
Is there a way I can ask sphinx to try to use the .description string to document bar?
Thank you in advance.
python python-sphinx
edited Nov 12 '18 at 16:57
mzjn
31.4k666154
asked Nov 12 '18 at 16:42
bustawin
726
1
There is no built-in way to do this. I don't have a concrete suggestion, but Sphinx is very customizable so (almost) anything is possible.
– mzjn
Nov 12 '18 at 17:02
There is some interesting stuff here: stackoverflow.com/questions/10307696/… but I'd say Sphinx is a better bet
– RHSmith159
Nov 12 '18 at 17:04
You can dobar.description = X.__doc__. Then you can use it just with normalautodoc.
– user69453
Nov 18 '18 at 14:08
add a comment |
0
0
0
I have class called Foo:
class Foo:
bar = X()
bar.description = 'My description of bar.'
foo.bar has an attribute describing it, as if it were its docstring. This happens to the majority of my attributes in Foo.
Is there a way I can ask sphinx to try to use the .description string to document bar?
Thank you in advance.
python python-sphinx
edited Nov 12 '18 at 16:57
mzjn
31.4k666154
asked Nov 12 '18 at 16:42
bustawin
726
I have class called Foo:
class Foo:
bar = X()
bar.description = 'My description of bar.'
foo.bar has an attribute describing it, as if it were its docstring. This happens to the majority of my attributes in Foo.
Is there a way I can ask sphinx to try to use the .description string to document bar?
Thank you in advance.
python python-sphinx
python python-sphinx
edited Nov 12 '18 at 16:57
mzjn
31.4k666154
asked Nov 12 '18 at 16:42
bustawin
726
edited Nov 12 '18 at 16:57
mzjn
31.4k666154
asked Nov 12 '18 at 16:42
bustawin
726
edited Nov 12 '18 at 16:57
mzjn
31.4k666154
edited Nov 12 '18 at 16:57
mzjn
31.4k666154
edited Nov 12 '18 at 16:57
mzjn
31.4k666154
31.4k666154
asked Nov 12 '18 at 16:42
bustawin
726
asked Nov 12 '18 at 16:42
bustawin
726
asked Nov 12 '18 at 16:42
bustawin
726
726
1
There is no built-in way to do this. I don't have a concrete suggestion, but Sphinx is very customizable so (almost) anything is possible.
– mzjn
Nov 12 '18 at 17:02
There is some interesting stuff here: stackoverflow.com/questions/10307696/… but I'd say Sphinx is a better bet
– RHSmith159
Nov 12 '18 at 17:04
You can dobar.description = X.__doc__. Then you can use it just with normalautodoc.
– user69453
Nov 18 '18 at 14:08
add a comment |
1
There is no built-in way to do this. I don't have a concrete suggestion, but Sphinx is very customizable so (almost) anything is possible.
– mzjn
Nov 12 '18 at 17:02
There is some interesting stuff here: stackoverflow.com/questions/10307696/… but I'd say Sphinx is a better bet
– RHSmith159
Nov 12 '18 at 17:04
You can dobar.description = X.__doc__. Then you can use it just with normalautodoc.
– user69453
Nov 18 '18 at 14:08
1
1
There is no built-in way to do this. I don't have a concrete suggestion, but Sphinx is very customizable so (almost) anything is possible.
– mzjn
Nov 12 '18 at 17:02
There is no built-in way to do this. I don't have a concrete suggestion, but Sphinx is very customizable so (almost) anything is possible.
– mzjn
Nov 12 '18 at 17:02
There is some interesting stuff here: stackoverflow.com/questions/10307696/… but I'd say Sphinx is a better bet
– RHSmith159
Nov 12 '18 at 17:04
There is some interesting stuff here: stackoverflow.com/questions/10307696/… but I'd say Sphinx is a better bet
– RHSmith159
Nov 12 '18 at 17:04
You can do
bar.description = X.__doc__. Then you can use it just with normal autodoc.– user69453
Nov 18 '18 at 14:08
You can do
bar.description = X.__doc__. Then you can use it just with normal autodoc.– user69453
Nov 18 '18 at 14:08
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
});
}
});
draft saved
draft discarded
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%2f53266530%2fuse-an-attribute-value-as-docstring%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
draft saved
draft discarded
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.
draft saved
draft discarded
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%2f53266530%2fuse-an-attribute-value-as-docstring%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
1
There is no built-in way to do this. I don't have a concrete suggestion, but Sphinx is very customizable so (almost) anything is possible.
– mzjn
Nov 12 '18 at 17:02
There is some interesting stuff here: stackoverflow.com/questions/10307696/… but I'd say Sphinx is a better bet
– RHSmith159
Nov 12 '18 at 17:04
You can do
bar.description = X.__doc__. Then you can use it just with normalautodoc.– user69453
Nov 18 '18 at 14:08