Skip to content

Commit 250d7f4

Browse files
Docs: Updated config
* Updated author settings * Workaround: Disabled `sphinx.ext.viewcode` (#187)
1 parent 1e9db08 commit 250d7f4

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

.readthedocs.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
44
version: 2
55
build:
6-
os: ubuntu-22.04
6+
os: ubuntu-24.04
77
tools:
8-
python: "3.11"
8+
python: "3.12"
99
sphinx:
1010
configuration: doc/source/conf.py
1111
python:
1212
install:
13-
- requirements: requirements.txt
14-
- requirements: requirements_devel.txt
13+
- requirements: requirements.txt
14+
- requirements: requirements_devel.txt

doc/source/conf.py

+7-6
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@
4141
# ones.
4242
extensions = [
4343
'sphinx.ext.autodoc',
44-
'sphinx.ext.viewcode',
44+
# Disabling the extension because of https://github.com/sphinx-doc/sphinx/issues/13095
45+
# 'sphinx.ext.viewcode',
4546
]
4647

4748
# Add any paths that contain templates here, relative to this directory.
@@ -131,8 +132,8 @@
131132
# (source start file, target name, title,
132133
# author, documentclass [howto, manual, or own class]).
133134
latex_documents = [
134-
(master_doc, 'OSCTiny.tex', 'OSC Tiny Documentation',
135-
'Andreas Hasenkopf', 'manual'),
135+
(master_doc, 'OSCTiny.tex', project + ' Documentation',
136+
author, 'manual'),
136137
]
137138

138139

@@ -141,7 +142,7 @@
141142
# One entry per manual page. List of tuples
142143
# (source start file, name, description, authors, manual section).
143144
man_pages = [
144-
(master_doc, 'osctiny', 'OSC Tiny Documentation',
145+
(master_doc, 'osctiny', project + ' Documentation',
145146
[author], 1)
146147
]
147148

@@ -152,8 +153,8 @@
152153
# (source start file, target name, title, author,
153154
# dir menu entry, description, category)
154155
texinfo_documents = [
155-
(master_doc, 'OSCTiny', 'OSC Tiny Documentation',
156-
author, 'OSCTiny', 'One line description of project.',
156+
(master_doc, project, project + ' Documentation',
157+
author, project, 'One line description of project.',
157158
'Miscellaneous'),
158159
]
159160

0 commit comments

Comments
 (0)