Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[documentation] autogenerate pretty formatting of docs #9

Open
1 of 6 tasks
suzannejin opened this issue Nov 4, 2024 · 0 comments
Open
1 of 6 tasks

[documentation] autogenerate pretty formatting of docs #9

suzannejin opened this issue Nov 4, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@suzannejin
Copy link
Collaborator

suzannejin commented Nov 4, 2024

Goal: generate pretty docs using uv. please check: https://github.com/pawamoy/copier-uv
thanks to @kenibrewer recommendation!

  • add template
  • pass make check-quality, which checks the code quality
  • pass make check-docs, which checks if the documentation builds correctly
  • pass make check-type, which check if the code is correctly typed
  • convert unittest into pytest
  • pass make test
@suzannejin suzannejin self-assigned this Nov 4, 2024
@suzannejin suzannejin modified the milestone: restructure stimulus Nov 4, 2024
@suzannejin suzannejin changed the title [feature] autogenerate pretty formatting of docs [documentation] autogenerate pretty formatting of docs Nov 4, 2024
@suzannejin suzannejin added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant