Skip to content

Add documentation using Sphinx-apidoc and Read The Docs for automated docs #15

@sword134

Description

@sword134

Hello,

I've stumbled upon this package and made a local clone on which I am sucessfully running sphinx for documentation purposes. The package already has extensive docstrings for each class and function.

It takes a few minutes to get the hang of and setup, but i'd say its well worth it and would allow for a new users to get involved with the package and potentially open pull requests in the future.

For online hosting via Read the docs: https://docs.readthedocs.com/platform/stable/tutorial/index.html
Sphinx docs auto generation: https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html

Full walkthrough tutorial: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/install.html

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions