Skip to content

Add documentation to repository #52

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

Open
4 of 5 tasks
klauer opened this issue Mar 30, 2023 · 0 comments
Open
4 of 5 tasks

Add documentation to repository #52

klauer opened this issue Mar 30, 2023 · 0 comments

Comments

@klauer
Copy link
Owner

klauer commented Mar 30, 2023

  • Add sphinx (or mkdocs would be fine too) documentation to the repository
  • Document the blark API (automatically)
  • Document the blark CLI entrypoint
  • Add in stuff from the README to the documentation and expound upon it
  • Add a CI job to deploy documentation (preferably with docs-versions-menu)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant