FL-Studio-API-Stubs icon indicating copy to clipboard operation
FL-Studio-API-Stubs copied to clipboard

Add a build system that can rewrite docstrings to reduce the huge amounts of repetition

Open MaddyGuthridge opened this issue 5 months ago • 1 comments

  • [ ] Figure out a way to hook into Poetry's build system to rewrite all of the docstrings
  • [x] Set up a templating system so that repetitive parts of the docstrings can be added easily

Things to template-ify:

  • Note on colors using utils module
  • Note on playlist track indexes

Other useful features:

  • Allow for separate rewriting depending on whether we are building the documentation site, or the Python package
  • Rewrite links to functions to be documentation page links (full URL for docs package, internal link for the docs site)

MaddyGuthridge avatar Jan 19 '24 05:01 MaddyGuthridge