You are here

Suggestion: setting Sphinx documentation to not skip __init__

1 post / 0 new
Suggestion: setting Sphinx documentation to not skip __init__
#1

The online documentation for pyrosetta is great. However, one problem is that the __init__ is not documented as it's handy to know what are the possible arguments for the class.

Sphinx does not document by default so this absence totally makes sense and `help(...)` or instantiating with something wrong will reveal what is accepted anyway. However, to circumvent this one simply needs to define a method for the `autodoc-skip-member` attribute in the config.py file for sphinx, which is a few lines (e.g. https://stackoverflow.com/questions/5599254/how-to-use-sphinxs-autodoc-to-document-a-classs-init-self-method). So I thought I'd best suggest it!

Thanks!

 

Category: 
Post Situation: 
Mon, 2020-08-24 09:02
matteoferla