Add sphinx documentation site

[empicano]

I set up Sphinx!

The documentation is live at https://sbtinstruments.github.io/asyncio-mqtt. I thought about deploying to ReadTheDocs, but they show ads, so I stuck with GitHub Pages, even though the URL is not that nice.

It's still a bit rough on the edges. For now, I only copied the "Advanced usage" Section.

I want to clean up the README still (to not have duplication anywhere), add an introduction to the Sphinx docs, and integrate the information from the examples folder.

Let me know what you think! 😊

~Felix

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (main@db997d8). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head d53b5d7 differs from pull request most recent head c57cbaf. Consider uploading reports for the commit c57cbaf to get more accurate results

@@          Coverage Diff           @@
##             main    #159   +/-   ##
======================================
  Coverage        ?   91.0%           
======================================
  Files           ?       7           
  Lines           ?     714           
  Branches        ?     150           
======================================
  Hits            ?     650           
  Misses          ?      41           
  Partials        ?      23           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[JonathanPlasse]

The section Topic filter does not contain filters with wildcards which could make believe that it is not possible.

[frederikaalund]

It looks really good! A very nice initiative, indeed. 👍

I like the simplicity of it as well. After all, asyncio-mqtt is a tiny wrapper around paho-mqtt.

Some suggestions for further work:

• Add a "repo" link back to GitHub.
• Similarly, add an "issue tracker" link to our GitHub-based issues page.

[empicano]

Thanks for the feedback! 😎

The section Topic filter does not contain filters with wildcards which could make believe that it is not possible.

You're right 👍 The new example for #147 includes wildcards.

Some suggestions for further work: [...]

Great ideas, done!

[JonathanPlasse]

Awesome 🎉

[empicano]

Thank you! 😊

[frederikaalund]

Looks great! 😄 Well done. 👍 We really needed better docs sooner rather than later.