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.

Sign up for GitHub

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

Jump to bottom

Make nicer looking docs #7

Open
JacksonElia opened this issue Feb 24, 2025 · 0 comments
Open

Make nicer looking docs #7

JacksonElia opened this issue Feb 24, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@JacksonElia
Copy link
Member

For now, I'm going to generate just typical JavaDoc because all public methods and classes do have docstrings, but eventually I want to make something nicer looking with examples and more guidance. Probably going to use https://about.readthedocs.com/
@JacksonElia JacksonElia added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JacksonElia