Skip to content

Generate API documentation #49

@riley-harper

Description

@riley-harper

We ought to generate some API documentation for LinkRun and all the related classes and functions that are part of hlink's API. These docs could be linked to from the current hlink.docs.ipums.org website, or they could be a subsection of that site.

I'm pretty sure that Sphinx is capable of generating this sort of documentation, so let's try that out sometime since we're already using Sphinx.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions