Add minimal documentation

joweich / chat-miner

Parsers and visualizations for chats

MIT License

567 stars 56 forks source link

Add minimal documentation #100

Closed joweich closed 8 months ago

joweich commented 1 year ago

Goal

Docs should be generated with Sphinx and hosted on readthedocs. This issue is meant to introduce a first minimal documentation that is to be extended in future PRs.

Jobs to be done

[ ] Add minimal sphinx configuration
[ ] Deploy documentation on readthedocs
[ ] [OPTIONAL] Add GitHub workflow for automatic deployment if PRs are merged on main

github-actions[bot] commented 8 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs.