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

Proposed by Guruprasad
Status: Merged
Merged at revision: 95139c1a86f8812c8c7f94f679a7431b2691527e
Proposed branch: ~lgp171188/lazr.restful:add-readthedocs-yaml
Merge into: lazr.restful:main
Diff against target: 49 lines (+19/-2)
3 files modified
.readthedocs.yaml (+17/-0)
src/lazr/restful/docs/conf.py (+1/-1)
tox.ini (+1/-1)
Reviewer Review Type Date Requested Status
Jürgen Gmach Approve
Review via email: mp+452771@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..ed3ba12
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/restful/docs/conf.py
23+ fail_on_warning: true
24diff --git a/src/lazr/restful/docs/conf.py b/src/lazr/restful/docs/conf.py
25index f1c692d..e34c538 100644
26--- a/src/lazr/restful/docs/conf.py
27+++ b/src/lazr/restful/docs/conf.py
28@@ -63,7 +63,7 @@ release = __version__
29 #
30 # This is also used if you do content translation via gettext catalogs.
31 # Usually you set "language" from the command line for these cases.
32-language = None
33+language = "en"
34
35 # List of patterns, relative to source directory, that match files and
36 # directories to ignore when looking for source files.
37diff --git a/tox.ini b/tox.ini
38index 4b07cac..fde564a 100644
39--- a/tox.ini
40+++ b/tox.ini
41@@ -26,7 +26,7 @@ commands =
42 pre-commit run -a
43
44 [testenv:docs]
45-basepython = python3
46+basepython = python3.11
47 deps =
48 .[docs]
49 commands =

Subscribers

People subscribed via source and target branches