Documentation ready package · Issue #852 · TezRomacH/python-package-template · GitHub
Skip to content
This repository was archived by the owner on Feb 7, 2024. It is now read-only.
This repository was archived by the owner on Feb 7, 2024. It is now read-only.

Documentation ready package #852

Open

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

Activity

  1. github-actions commented on Jun 15, 2023

    @github-actions

    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 join this conversation on GitHub. Already have an account? Sign in to comment

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