ape icon indicating copy to clipboard operation
ape copied to clipboard

Published 20 hours ago • verified publisher icon ApeWorX

Add doc generation to plugins from readme

Open NotPeopling2day opened this issue 3 years ago • 2 comments

Overview

@fubuloubu suggested during Sprint 5 retro that we add doc generation to plugins from readme.

Specification

Take doc generation logic mirroring current core functionality but apply it to each plugin repo. Note: Good intern project

Dependencies

NotPeopling2day avatar Aug 06 '22 00:08 NotPeopling2day

Hello! I would like to work on this if possible. Please let me know if I can work on this, thanks!

naevern avatar May 27 '25 16:05 naevern

Hello! I would like to work on this if possible. Please let me know if I can work on this, thanks!

Hey @naevern, thanks for offering to take this on!

We have a sphinx plugin that makes this really easy, would definitely accept PRs to our plugin repos for the update: https://github.com/ApeWorX/sphinx-ape

see https://github.com/ApeWorX/ape-alchemy/commit/4d5e2d3c8b54a49d565d77505d36f6c5f5a3af1d for an example how this is done

fubuloubu avatar May 27 '25 21:05 fubuloubu