Skip to content

Discussion: Generalization of package #21

Open
@bendichter

Description

I think it's pretty clear that the features of this library and even more so the general goal of the library could be broadly useful for a large variety of software within and outside neuroscience. I'm opening this ticket as a place to discuss how we might generalize this package to be more broadly applicable. @oruebel, what exactly would need to be done to generalize this so it could be applied to any Python package? What are the places that are currently NWB-specific?

One option could be to refactor this into a sphinx extension so it could be auto-generated as an additional page on the ReadTheDocs of any package, similar to how auto API currently works. I suppose the challenge of that would be that we would need to use the RTD build services, which might fail if this takes too long. Is there a way to build docs using GitHub Actions instead?

cc @alejoe91 @rly @oruebel

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions