search

JMMP-Group / nordic-seas-validation

MIT License
0 stars 1 forks source link

Generate API using pre-commit #19

Closed malmans2 closed 2 years ago

malmans2 commented 2 years ago

Closes #18 I added a pre-commit task that generates docs/api.md. Nothing fancy, but shows all documented functions.

The only caveat is that we have to use google-style docstrings rather than numpy-style: Example:

def function(param1: int, param2: str) -> bool:
    """Example function.

    Args:
        param1: The first parameter.
        param2: The second parameter.

    Returns:
        The return value. True for success, False otherwise.
    """
malmans2 commented 2 years ago

Merging to test, looks like workflows are not working from external forks