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

Add documentation #14

Open
4 tasks
PythonTryHard opened this issue Dec 10, 2022 · 0 comments
Open
4 tasks

Add documentation #14

PythonTryHard opened this issue Dec 10, 2022 · 0 comments

Comments

@PythonTryHard
Copy link
Owner

Currently, our docs is garbage: Paragraphs of docstrings does not conform to a format. If we tout our toolkit as a library as well as a CLI app, then we NEED docs.

  • Pick a docs generator.
  • Format docs accordingly.
  • Set up hooks for auto-generating docs. (optional)
  • Host the docs somewhere.
@PythonTryHard PythonTryHard converted this from a draft issue Dec 10, 2022
@PythonTryHard PythonTryHard moved this from Todo to In Progress in v0.2.0 Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
v0.2.0
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@PythonTryHard