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
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
0new file mode 1006440new file mode 100644
index 0000000..ed3ba12
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,17 @@
1version: 2
2
3build:
4 os: ubuntu-22.04
5 tools:
6 python: "3.11"
7
8python:
9 install:
10 - method: pip
11 path: .
12 extra_requirements:
13 - docs
14
15sphinx:
16 configuration: src/lazr/restful/docs/conf.py
17 fail_on_warning: true
diff --git a/src/lazr/restful/docs/conf.py b/src/lazr/restful/docs/conf.py
index f1c692d..e34c538 100644
--- a/src/lazr/restful/docs/conf.py
+++ b/src/lazr/restful/docs/conf.py
@@ -63,7 +63,7 @@ release = __version__
63#63#
64# This is also used if you do content translation via gettext catalogs.64# This is also used if you do content translation via gettext catalogs.
65# Usually you set "language" from the command line for these cases.65# Usually you set "language" from the command line for these cases.
66language = None66language = "en"
6767
68# List of patterns, relative to source directory, that match files and68# List of patterns, relative to source directory, that match files and
69# directories to ignore when looking for source files.69# directories to ignore when looking for source files.
diff --git a/tox.ini b/tox.ini
index 4b07cac..fde564a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -26,7 +26,7 @@ commands =
26 pre-commit run -a26 pre-commit run -a
2727
28[testenv:docs]28[testenv:docs]
29basepython = python329basepython = python3.11
30deps =30deps =
31 .[docs]31 .[docs]
32commands =32commands =

Subscribers

People subscribed via source and target branches