Suggestion: setting Sphinx documentation to not skip __init__

Member Site Forums PyRosetta PyRosetta – General Suggestion: setting Sphinx documentation to not skip __init__

Viewing 0 reply threads
  • Author
    Posts
    • #3553
      Anonymous

        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!

         

    Viewing 0 reply threads
    • You must be logged in to reply to this topic.