Skip to content

Allow option for napoleon docs rather than sphinx #251

@fwkoch

Description

@fwkoch

The plain-text docstrings (i.e. accessed from ipython) are sometimes hard to read due to sphinx formatting. A small aspect of this was addressed in response to this issue here: #8 but overall, docs are still sphinx through-and-through.

It would be great to enable easier to read docs with Napolen - https://sphinxcontrib-napoleon.readthedocs.io/en/latest/ - this could mean a couple of things. Either (1) have a check for __IPTYTHON__ (or maybe just a flag on the HasProperties class) that causes napolean docs to be built instead of sphinx, or (2) only build napoleon docs and use the sphinx extension to build docs from there.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions