Mixing
Class attribute docstring inside class docstring block
I'm documenting my Python project with Sphinx, and want to document class attributes inside the class docstring block. Attribute inline docstrings are ugly.
I did try adding attribute docstring to class docstring block but when Sphinx makes html, it does not show properly.
class MyClass():
"""
MyClass docstring block.
Attributes:
name - A single attribute.
:attr name - A single attribute.
"""
name = "ABC"
The generated html displays a simple line. Instead with attribute inline docstring display a nice style.
Attribute inline docstring
Attribute docstring in class block docstring
python python-sphinx docstring
asked Jan 2 at 16:32
cristhiamcristhiam
184
add a comment |
I'm documenting my Python project with Sphinx, and want to document class attributes inside the class docstring block. Attribute inline docstrings are ugly.
I did try adding attribute docstring to class docstring block but when Sphinx makes html, it does not show properly.
class MyClass():
"""
MyClass docstring block.
Attributes:
name - A single attribute.
:attr name - A single attribute.
"""
name = "ABC"
The generated html displays a simple line. Instead with attribute inline docstring display a nice style.
Attribute inline docstring
Attribute docstring in class block docstring
python python-sphinx docstring
asked Jan 2 at 16:32
cristhiamcristhiam
184
Do not post images of code. Post your actual code.
– Steve Piercy
Jan 3 at 9:41
add a comment |
I'm documenting my Python project with Sphinx, and want to document class attributes inside the class docstring block. Attribute inline docstrings are ugly.
I did try adding attribute docstring to class docstring block but when Sphinx makes html, it does not show properly.
class MyClass():
"""
MyClass docstring block.
Attributes:
name - A single attribute.
:attr name - A single attribute.
"""
name = "ABC"
The generated html displays a simple line. Instead with attribute inline docstring display a nice style.
Attribute inline docstring
Attribute docstring in class block docstring
python python-sphinx docstring
asked Jan 2 at 16:32
cristhiamcristhiam
184
I'm documenting my Python project with Sphinx, and want to document class attributes inside the class docstring block. Attribute inline docstrings are ugly.
I did try adding attribute docstring to class docstring block but when Sphinx makes html, it does not show properly.
class MyClass():
"""
MyClass docstring block.
Attributes:
name - A single attribute.
:attr name - A single attribute.
"""
name = "ABC"
The generated html displays a simple line. Instead with attribute inline docstring display a nice style.
Attribute inline docstring
Attribute docstring in class block docstring
python python-sphinx docstring
python python-sphinx docstring
asked Jan 2 at 16:32
cristhiamcristhiam
184
asked Jan 2 at 16:32
cristhiamcristhiam
184
edited Jan 2 at 19:08
cristhiam
asked Jan 2 at 16:32
cristhiamcristhiam
184
asked Jan 2 at 16:32
cristhiamcristhiam
184
asked Jan 2 at 16:32
cristhiamcristhiam
184
184
Do not post images of code. Post your actual code.
– Steve Piercy
Jan 3 at 9:41
add a comment |
Do not post images of code. Post your actual code.
– Steve Piercy
Jan 3 at 9:41
Do not post images of code. Post your actual code.
– Steve Piercy
Jan 3 at 9:41
Do not post images of code. Post your actual code.
– Steve Piercy
Jan 3 at 9:41
add a comment |
1 Answer
1
active
oldest
votes
You should put a colon after the attribute name:
class MyClass():
"""MyClass docstring block.
Attributes:
name: A single attribute.
name: A single attribute.
"""
name = "ABC"
answered Jan 2 at 18:34
Serge BallestaSerge Ballesta
81.1k961133
1
Thank you @Serge Ballesta I tried that. No results.
– cristhiam
Jan 2 at 19:04
add a comment |
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%2f54009886%2fclass-attribute-docstring-inside-class-docstring-block%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
You should put a colon after the attribute name:
class MyClass():
"""MyClass docstring block.
Attributes:
name: A single attribute.
name: A single attribute.
"""
name = "ABC"
answered Jan 2 at 18:34
Serge BallestaSerge Ballesta
81.1k961133
1
Thank you @Serge Ballesta I tried that. No results.
– cristhiam
Jan 2 at 19:04
add a comment |
You should put a colon after the attribute name:
class MyClass():
"""MyClass docstring block.
Attributes:
name: A single attribute.
name: A single attribute.
"""
name = "ABC"
answered Jan 2 at 18:34
Serge BallestaSerge Ballesta
81.1k961133
1
Thank you @Serge Ballesta I tried that. No results.
– cristhiam
Jan 2 at 19:04
add a comment |
You should put a colon after the attribute name:
class MyClass():
"""MyClass docstring block.
Attributes:
name: A single attribute.
name: A single attribute.
"""
name = "ABC"
answered Jan 2 at 18:34
Serge BallestaSerge Ballesta
81.1k961133
You should put a colon after the attribute name:
class MyClass():
"""MyClass docstring block.
Attributes:
name: A single attribute.
name: A single attribute.
"""
name = "ABC"
answered Jan 2 at 18:34
Serge BallestaSerge Ballesta
81.1k961133
answered Jan 2 at 18:34
Serge BallestaSerge Ballesta
81.1k961133
answered Jan 2 at 18:34
Serge BallestaSerge Ballesta
81.1k961133
answered Jan 2 at 18:34
Serge BallestaSerge Ballesta
81.1k961133
81.1k961133
1
Thank you @Serge Ballesta I tried that. No results.
– cristhiam
Jan 2 at 19:04
add a comment |
1
Thank you @Serge Ballesta I tried that. No results.
– cristhiam
Jan 2 at 19:04
1
1
Thank you @Serge Ballesta I tried that. No results.
– cristhiam
Jan 2 at 19:04
Thank you @Serge Ballesta I tried that. No results.
– cristhiam
Jan 2 at 19:04
add a comment |
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%2f54009886%2fclass-attribute-docstring-inside-class-docstring-block%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
Do not post images of code. Post your actual code.
– Steve Piercy
Jan 3 at 9:41