Skip to content

Commit 8bc3373

Browse files
committed
Add .readthedocs.yml, and install sphinx etc as docs extra
1 parent 29f8bf5 commit 8bc3373

File tree

2 files changed

+29
-4
lines changed

2 files changed

+29
-4
lines changed

.readthedocs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Build documentation in the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/conf.py
11+
12+
# Optionally build your docs in additional formats such as PDF
13+
formats:
14+
- pdf
15+
16+
# Optionally set the version of Python and requirements required to build your docs
17+
python:
18+
version: 3.7
19+
install:
20+
- path: .
21+
extra_requirements:
22+
- docs

pyproject.toml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,18 @@ license = "MIT"
77
readme = "README.md"
88
homepage = "https://github.com/alexsdutton/python-maestro-servo"
99
documentation = "https://maestro-servo.readthedocs.org/"
10-
packages = ["maestro"]
10+
packages = [
11+
{ include = "maestro"},
12+
]
1113

1214
[tool.poetry.dependencies]
1315
python = ">=3.7"
1416
pyusb = "^1.1.0"
17+
Sphinx = { version = "^3.4.3", optional = true }
18+
sphinx-autodoc-annotation = { version = "^1.0-1", optional = true }
1519

16-
[tool.poetry.dev-dependencies]
17-
Sphinx = "^3.4.3"
18-
sphinx-autodoc-annotation = "^1.0-1"
20+
[tool.poetry.extras]
21+
docs = ["Sphinx", "sphinx-autodoc-annotation"]
1922

2023
[build-system]
2124
requires = ["poetry-core>=1.0.0"]

0 commit comments

Comments
 (0)