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

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

Open
1 of 2 tasks
MaddyGuthridge opened this issue Jan 19, 2024 · 1 comment

Comments

@MaddyGuthridge
Copy link
Owner

MaddyGuthridge commented Jan 19, 2024

  • Figure out a way to hook into Poetry's build system to rewrite all of the docstrings
  • 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
Copy link
Owner Author

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

No branches or pull requests

1 participant