How to parse keras docstrings with Sphinx when inheriting them with autodoc
I am building a package that uses keras classes.
I am generating my documentation with Sphinx, using the Google docstring convention with napoleon to parse it.
Some of my methods override keras methods and are not documented, so the Sphinx autodoc inherit the docstrings from the original overriden method in keras.
Unfortunately, the documentation in keras does not follow the Google nor the numpy, nor the reST docstring convention. It is a kind of Google convention with '#' symbols from markdown I think, here is an example:
def keras_doc_example(inputs, **kwargs):
"""
# Arguments
inputs: Can be a tensor or list/tuple of tensors.
**kwargs: Additional keyword arguments.
# Returns
An output.
"""
So when I build my documentation, all documentation from keras docstrings look broken with unrecognized '#' symbols.
What is the way to correctly parse this keras docstring convention?
python keras documentation python-sphinx
asked Jan 3 at 16:52
Cyril De CatheuCyril De Catheu
61
add a comment |
I am building a package that uses keras classes.
I am generating my documentation with Sphinx, using the Google docstring convention with napoleon to parse it.
Some of my methods override keras methods and are not documented, so the Sphinx autodoc inherit the docstrings from the original overriden method in keras.
Unfortunately, the documentation in keras does not follow the Google nor the numpy, nor the reST docstring convention. It is a kind of Google convention with '#' symbols from markdown I think, here is an example:
def keras_doc_example(inputs, **kwargs):
"""
# Arguments
inputs: Can be a tensor or list/tuple of tensors.
**kwargs: Additional keyword arguments.
# Returns
An output.
"""
So when I build my documentation, all documentation from keras docstrings look broken with unrecognized '#' symbols.
What is the way to correctly parse this keras docstring convention?
python keras documentation python-sphinx
asked Jan 3 at 16:52
Cyril De CatheuCyril De Catheu
61
add a comment |
I am building a package that uses keras classes.
I am generating my documentation with Sphinx, using the Google docstring convention with napoleon to parse it.
Some of my methods override keras methods and are not documented, so the Sphinx autodoc inherit the docstrings from the original overriden method in keras.
Unfortunately, the documentation in keras does not follow the Google nor the numpy, nor the reST docstring convention. It is a kind of Google convention with '#' symbols from markdown I think, here is an example:
def keras_doc_example(inputs, **kwargs):
"""
# Arguments
inputs: Can be a tensor or list/tuple of tensors.
**kwargs: Additional keyword arguments.
# Returns
An output.
"""
So when I build my documentation, all documentation from keras docstrings look broken with unrecognized '#' symbols.
What is the way to correctly parse this keras docstring convention?
python keras documentation python-sphinx
asked Jan 3 at 16:52
Cyril De CatheuCyril De Catheu
61
I am building a package that uses keras classes.
I am generating my documentation with Sphinx, using the Google docstring convention with napoleon to parse it.
Some of my methods override keras methods and are not documented, so the Sphinx autodoc inherit the docstrings from the original overriden method in keras.
Unfortunately, the documentation in keras does not follow the Google nor the numpy, nor the reST docstring convention. It is a kind of Google convention with '#' symbols from markdown I think, here is an example:
def keras_doc_example(inputs, **kwargs):
"""
# Arguments
inputs: Can be a tensor or list/tuple of tensors.
**kwargs: Additional keyword arguments.
# Returns
An output.
"""
So when I build my documentation, all documentation from keras docstrings look broken with unrecognized '#' symbols.
What is the way to correctly parse this keras docstring convention?
python keras documentation python-sphinx
python keras documentation python-sphinx
asked Jan 3 at 16:52
Cyril De CatheuCyril De Catheu
61
asked Jan 3 at 16:52
Cyril De CatheuCyril De Catheu
61
asked Jan 3 at 16:52
Cyril De CatheuCyril De Catheu
61
asked Jan 3 at 16:52
Cyril De CatheuCyril De Catheu
61
asked Jan 3 at 16:52
Cyril De CatheuCyril De Catheu
61
61
add a comment |
add a comment |
0
active
oldest
votes
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%2f54026542%2fhow-to-parse-keras-docstrings-with-sphinx-when-inheriting-them-with-autodoc%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%2f54026542%2fhow-to-parse-keras-docstrings-with-sphinx-when-inheriting-them-with-autodoc%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
