Merge ~lgp171188/lazr.delegates:add-readthedocs-yaml into lazr.delegates:main

Proposed by Guruprasad
Status: Merged
Merged at revision: 2e490d8fa5fc380433d9ee898cd01e31965347cd
Proposed branch: ~lgp171188/lazr.delegates:add-readthedocs-yaml
Merge into: lazr.delegates:main
Diff against target: 49 lines (+19/-2)
3 files modified
.readthedocs.yaml (+17/-0)
src/lazr/delegates/docs/conf.py (+1/-1)
tox.ini (+1/-1)
Reviewer Review Type Date Requested Status
Jürgen Gmach Approve
Review via email: mp+452736@code.launchpad.net

Commit message

Add a .readthedocs.yaml configuration file

Also update tox.ini to build docs using Python 3.11

To post a comment you must log in.
Revision history for this message
Jürgen Gmach (jugmac00) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/.readthedocs.yaml b/.readthedocs.yaml
2new file mode 100644
3index 0000000..9311d28
4--- /dev/null
5+++ b/.readthedocs.yaml
6@@ -0,0 +1,17 @@
7+version: 2
8+
9+build:
10+ os: ubuntu-22.04
11+ tools:
12+ python: "3.11"
13+
14+python:
15+ install:
16+ - method: pip
17+ path: .
18+ extra_requirements:
19+ - docs
20+
21+sphinx:
22+ configuration: src/lazr/delegates/docs/conf.py
23+ fail_on_warning: true
24diff --git a/src/lazr/delegates/docs/conf.py b/src/lazr/delegates/docs/conf.py
25index adc0c50..62edc0a 100644
26--- a/src/lazr/delegates/docs/conf.py
27+++ b/src/lazr/delegates/docs/conf.py
28@@ -51,7 +51,7 @@ release = version
29
30 # The language for content autogenerated by Sphinx. Refer to documentation
31 # for a list of supported languages.
32-#language = None
33+language = "en"
34
35 # There are two options for replacing |today|: either, you set today to some
36 # non-false value, then it is used:
37diff --git a/tox.ini b/tox.ini
38index a8af84b..37ace58 100644
39--- a/tox.ini
40+++ b/tox.ini
41@@ -32,7 +32,7 @@ passenv =
42
43 [testenv:docs]
44 basepython =
45- python3
46+ python3.11
47 commands =
48 sphinx-build -b html -d src/lazr/delegates/docs/_build/doctrees src/lazr/delegates/docs src/lazr/delegates/docs/_build/html
49 deps =

Subscribers

People subscribed via source and target branches

to all changes: