Skip to content

Better API documentation #2

@andlaus

Description

@andlaus

The API documentation is generated from the python docstrings and it can be generated and inspected via

cd $ODXTOOLS_SRC_DIR/doc
make html
firefox _build/html/index.html

It IMO already looks decent, but it is sorely lacking in completeness and does not feature any "tutorial style" introductions. this should be changed in the medium to long term.

Andreas Lauser <[email protected]>, on behalf of MBition GmbH.
Provider Information

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first contributionGood for newcomershelp wantedExtra attention is needednice to haveThings which improve the quality of life but are not a matter of life and death.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions