Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Docs

# Build the Sphinx documentation and publish it to GitHub Pages.
# Replaces the never-provisioned solisconnect.readthedocs.io site (issue #33).

on:
push:
branches: [main]
paths:
- "docs/**"
- "README.md"
- ".github/workflows/docs.yaml"
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment; don't cancel an in-progress run.
concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Install docs dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx -r docs/requirements.txt

- name: Build HTML
run: sphinx-build -b html docs/source docs/_build/html

- uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The SolisCloud API support was framed with reference to these projects:

## Documentation

https://solisconnect.readthedocs.io/
https://fboundy.github.io/solisconnect/

## Installation

Expand Down Expand Up @@ -131,7 +131,7 @@ Home Assistant only allows one `iot_class` value in the manifest. SolisConnect i

- **Identification**: This field has been removed from the setup form. If you previously used it, the integration will still read it internally to migrate your old entities, but it is no longer user-configurable.

`Connection Type`: S2 is the default Modbus dongle option. Only select Waveshare if you are using a Waveshare device and some sensors are higher than normal. See https://solisconnect.readthedocs.io/en/latest/sensors.html#waveshare
`Connection Type`: S2 is the default Modbus dongle option. Only select Waveshare if you are using a Waveshare device and some sensors are higher than normal. See https://fboundy.github.io/solisconnect/sensors.html#waveshare

# [Solar card setup](https://github.com/slipx06/sunsynk-power-flow-card):

Expand Down
Loading