search

ynput / LabLib

Create VFX Dailies with Python! Can be used to render directly or as a module extending other code.
MIT License
2 stars 2 forks source link

[enhancing] Sphinx Docs #20

Closed jakubjezek001 closed 2 months ago

jakubjezek001 commented 2 months ago

Some additional changes on Sphinx Napoleon docstring compatibility adjustments. I have also added some docstring examples which sere resolving into following example HTML:

image image

image

Following is the recomanded docstring style:

"""Classmethod for scanning a directory for image sequences.

        Currently only supports EXR files. Needs to be extended and tested for other formats.

        Attributes:
            directory (Any[str, Path]): Path to the directory to be scanned.

        Returns:
            List[SequenceInfo]: List of all found image sequences
                as `SequenceInfo`.
        """

Inspired by https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

This PR is enhancing #17