Skip to content

Commit d011ff2

Browse files
committed
Ensure intersphinx mapping does not include current project
1 parent e77cb11 commit d011ff2

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/source/conf.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,20 +145,29 @@
145145
labscript_suite_doc_version = 'latest'
146146

147147
# add intersphinx references for each component
148+
labscript_intersphinx_mapping = {}
148149
for ls_prog in labscript_suite_programs:
149-
intersphinx_mapping[ls_prog] = (
150+
val = (
150151
'https://docs.labscriptsuite.org/projects/{}/en/{}/'.format(
151152
ls_prog, labscript_suite_doc_version
152153
),
153154
None,
154155
)
156+
labscript_intersphinx_mapping[ls_prog] = val
157+
if ls_prog != project:
158+
# don't add intersphinx for current project
159+
# if internal links break, they can silently be filled by links to existing online docs
160+
# this is confusing and difficult to detect
161+
intersphinx_mapping[ls_prog] = val
155162

156163
# add intersphinx reference for the metapackage
157164
if project != "the labscript suite":
158-
intersphinx_mapping['labscript-suite'] = (
165+
val = (
159166
'https://docs.labscriptsuite.org/en/{}/'.format(labscript_suite_doc_version),
160167
None,
161168
)
169+
intersphinx_mapping['labscript-suite'] = val
170+
labscript_intersphinx_mapping['labscript-suite'] = val
162171

163172
# Make `some code` equivalent to :code:`some code`
164173
default_role = 'code'
@@ -217,7 +226,7 @@ def setup(app):
217226
with open(Path(__file__).resolve().parent / 'components.rst', 'w') as f:
218227
f.write(
219228
template.render(
220-
intersphinx_mapping=intersphinx_mapping,
229+
intersphinx_mapping=labscript_intersphinx_mapping,
221230
programs=labscript_suite_programs,
222231
current_project=project,
223232
img_path=img_path

0 commit comments

Comments
 (0)