Skip to content

Problems with docstrings and sphinx documentation #141

Description

@kayhangultekin

Documentation with sphinx seems to be broken or semi-broken. It is possible to get around this by ignoring all errors, but it would be better to fix the issues.

To see what I mean, try building the documentation from the dev branch.

Doc strings are slightly poorly formatted and cause problems, leading sphinx to crash.

Seems to have been a problem since at least ea6b187.

There is also a bug in numpydoc/sphinx interaction that may be present in the version of numpydoc we are using: numpy/numpydoc Issue #268

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions