Add sphinx documentation site

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - README.md
+      - .github/workflows/docs.yml
+  pull_request:
+    paths:
+      - "docs/**"
+      - README.md
+      - .github/workflows/docs.yml
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Load cached dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: docs-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/pyproject.toml') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[docs]
+      - name: Build documentation
+        run: scripts/docs --no-reload
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build
+          publish_branch: documentation
+          user_name: "github-actions[bot]"
+          user_email: "github-actions[bot]@users.noreply.github.com"

.gitignore

@@ -8,3 +8,5 @@ local_test.py
 .coverage
 coverage.xml
 asyncio_mqtt/_version.py
+*.DS_Store
+docs/_build

CHANGELOG.md

@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Renamed `master` branch to `main`. Contributed by [Jonathan Plasse (@JonathanPlasse)](https://github.com/JonathanPlasse)
 
+### Added
+
+- Move documentation from `README` to Sphinx. Contributed by [Felix Böhm (@empicano)](https://github.com/empicano) in [#159](https://github.com/sbtinstruments/asyncio-mqtt/pull/159)
+- Add CI workflow to deploy documentation to GitHub Pages. Contributed by [Felix Böhm (@empicano)](https://github.com/empicano) in [#159](https://github.com/sbtinstruments/asyncio-mqtt/pull/159)
+
 ## [0.16.1]
 
 ### Fixed
@@ -55,10 +60,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Reorder `README.md` sections in order of importance. Contributed by [Felix Böhm (@empicano)](https://github.com/empicano) in [#140](https://github.com/sbtinstruments/asyncio-mqtt/pull/140)
 - Change from `setup.py` to `pyproject.toml`. Contributed by [Jonathan Plasse (@JonathanPlasse)](https://github.com/JonathanPlasse) in [#151](https://github.com/sbtinstruments/asyncio-mqtt/pull/151)
 
-### Deprecated
-
-- Deprecate `master` branch in favor of `main` branch.
-
 ### Removed
 
 - Drop Python 3.6 support. Contributed by [Jonathan Plasse (@JonathanPlasse)](https://github.com/JonathanPlasse) in [#146](https://github.com/sbtinstruments/asyncio-mqtt/pull/146)

CONTRIBUTING.md

@@ -25,7 +25,7 @@ pip install --upgrade pip
 Install the development dependencies.
 
 ```bash
-pip install -e .[tests,lint,format]
+pip install -e .[tests,lint,format,docs]
 ```
 
 Install [pre-commit](https://pre-commit.com/) so that your code is formatted and checked when you are doing a commit.
@@ -72,6 +72,10 @@ pytest --cov=src --cov=tests --cov-report=html
 
 To view the coverage open `htmlcov/index.html`.
 
+## Building the documentation
+
+The documentation uses [Sphinx](https://www.sphinx-doc.org/en/master/). The source files are located in the `docs` folder. You can build it by running `./scripts/docs`.
+
 ## Committing
 
 After doing `git commit`, `pre-commit` will check the committed code.