Build documentation website with MkDocs?

[milanmlft]

Was following this excellent Real Python tutorial on Building Python Project Documentation With MkDocs and was wondering whether this might be useful to set up for PIXL as well?

It would imply making our docstrings compatible with mkdocs though, which requires the following syntax:

def add(a, b):
    """Compute and return the sum of two numbers.

    Args:
        a (float): A number representing the first addend in the addition.
        b (float): A number representing the second addend in the addition.

    Returns:
        float: A number representing the arithmetic sum of `a` and `b`.
    """
    return float(a + b)

Guess there's a bunch of other tools out there to generate the documentation, but mkdocs is the only one with a green light from our python-tooling friends.

Happy to discuss!