Skip to content

Need to bring API docstrings into the docs #25

Description

@jimc101

Motivation

Desire to fully document pyfvcom2's API.

Approach

  • Investigate available tools for doing this (e.g., from sphinx) and implement the one best suited to the project, balancing simplicity, ease of maintenance and the quality of the documentation produced.
  • Ensure consistent docstring formatting and depth throughout the project (copilot should be able to help here).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    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