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

Documentation ready package #852

Open
VDuda opened this issue Jun 15, 2023 · 1 comment
Open

Documentation ready package #852

VDuda opened this issue Jun 15, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@VDuda
Copy link

VDuda commented Jun 15, 2023

🚀 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
@VDuda VDuda added the enhancement New feature or request label Jun 15, 2023
@github-actions
Copy link

Hello @VDuda, thank you for your interest in our work!

If this is a bug report, please provide screenshots and minimum viable code to reproduce your issue, otherwise we can not help you.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant