Skip to content
This repository was archived by the owner on Feb 7, 2024. It is now read-only.

Documentation ready packageΒ #852

@VDuda

Description

@VDuda

πŸš€ Feature Request

A documentation generator as part of this package. Would be nice to have a discussion on which generator to you; I default to ReadTheDocs, but I'm sure there are more modern generators nowadays? Would be happy to implement this feature.

πŸ”ˆ Motivation

I figured as part of a modern package stack you should have a documentation portal as the package grows.

πŸ›° Alternatives

Reading through the source code, googling, git

πŸ“Ž Additional context

A few doc generators that came to mind

  • ReadTheDocs
  • Docusaurus
  • GitBook
  • Sphinx

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions