8000 fix: Use "any" default role in sphinx (#550) · googleapis/python-spanner-django@196c449 · GitHub
[go: up one dir, main page]

Skip to content

Commit 196c449

Browse files
authored
fix: Use "any" default role in sphinx (#550)
So backtick'd text renders as code, links as appropriate.
1 parent 05a1640 commit 196c449

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,10 @@
239239
# Output file base name for HTML help builder.
240240
htmlhelp_basename = "google-cloud-spanner-django-doc"
241241

242+
# Use more convenient default role, affects text in single-backticks
243+
# https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-anything
244+
default_role = "any"
245+
242246
# -- Options for warnings ------------------------------------------------------
243247

244248

0 commit comments

Comments
 (0)
0