Various documentation updates (#333)

* Add a note about socket sharing

* Show inherited members for apidocs

* Remove outdated note of emeters not being supported on smartstrips

* Describe emeter and usage modules, add note about NTP for time sync

* Describe lib design and modules

* Bump sphinx version, ignore d001 (line-length) for doc8

* demote energy & usage to 3rd level, promote api for 2nd
This commit is contained in:
Teemu R
2022-04-06 01:13:27 +02:00
committed by GitHub
parent 68038c93df
commit d848117384
11 changed files with 140 additions and 28 deletions

View File

@@ -22,7 +22,7 @@ asyncclick = ">=8"
pydantic = "^1"
# required only for docs
sphinx = { version = "^3", optional = true }
sphinx = { version = "^4", optional = true }
m2r = { version = "^0", optional = true }
mistune = { version = "<2.0.0", optional = true }
sphinx_rtd_theme = { version = "^0", optional = true }
@@ -81,6 +81,10 @@ markers = [
"requires_dummy: test requires dummy data to pass, skipped on real devices",
]
[tool.doc8]
paths = ["docs"]
ignore = ["D001"]
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"