Skip to content

Commit df106db

Browse files
Support bool as sphinx :c:type:
1 parent 88fe00d commit df106db

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/_config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,13 @@ sphinx:
7171
["c:identifier", "uint32_t"],
7272
["c:identifier", "uint64_t"],
7373
["c:identifier", "FILE"],
74+
["c:identifier", "bool"],
7475
# This is for the anonymous interval struct embedded in the tsk_tree_t.
7576
["c:identifier", "tsk_tree_t.@1"],
7677
["c:type", "int32_t"],
7778
["c:type", "uint32_t"],
7879
["c:type", "uint64_t"],
80+
["c:type", "bool"],
7981
# TODO these have been triaged here to make the docs compile, but we should
8082
# sort them out properly. https://github.com/tskit-dev/tskit/issues/336
8183
["py:class", "array_like"],
@@ -89,6 +91,18 @@ sphinx:
8991
["py:class", "dtype=np.int64"],
9092
]
9193

94+
# Added to allow "bool" be used as a :ctype: - this list has to be
95+
# manually specifed in order to remove "bool" from it.
96+
c_extra_keywords: [
97+
"alignas",
98+
"alignof",
99+
"complex",
100+
"imaginary",
101+
"noreturn",
102+
"static_assert",
103+
"thread_local"
104+
]
105+
92106
autodoc_member_order: bysource
93107

94108
# Without this option, autodoc tries to put links for all return types

0 commit comments

Comments
 (0)