You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: surveys/sphinx-survey-2025.yml
+69-44Lines changed: 69 additions & 44 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,11 @@
1
1
# Copyright (c) 2025, Quansight Inc.
2
2
3
+
# Objective: Gain basic insight about about Sphinx in the wild; who is using it, for what, with what, and with what priorities?
4
+
# The goal is to augment discussions on features and issues with feedback that can be followed up on. The survey will not provide prescriptive solutions.
5
+
6
+
# Target audience: People who interact with documentation, especially those who contribute to or extend documentation. Use of Sphinx is encouraged but not required.
7
+
8
+
3
9
title: "Sphinx Survey 2025"
4
10
questions:
5
11
- title: "Sphinx Usage Survey 2025"
@@ -31,19 +37,20 @@ questions:
31
37
- "I build extensions for Sphinx"
32
38
- "I maintain a Sphinx theme"
33
39
- "I contribute to Sphinx"
40
+
- "None of the above"
34
41
35
42
- title: "Which of the following roles is closest to your job?"
36
-
other: true
37
-
choices:
38
-
- "Academic researcher"
39
-
- "Data scientist"
40
-
- "Developer / Programmer"
41
-
- "ML engineer / MLOps"
42
-
- "Product manager"
43
-
- "QA engineer"
44
-
- "Technical support"
45
-
- "Technical writer"
46
-
- "Prefer not to answer"
43
+
other: true
44
+
choices:
45
+
- "Academic researcher"
46
+
- "Data scientist"
47
+
- "Developer / Programmer"
48
+
- "ML engineer / MLOps"
49
+
- "Product manager"
50
+
- "QA engineer"
51
+
- "Technical support"
52
+
- "Technical writer"
53
+
- "Prefer not to answer"
47
54
48
55
- title: "Do you most often work on a team or independently?"
49
56
other: true
@@ -85,23 +92,28 @@ questions:
85
92
multiple: true
86
93
other: true
87
94
choices:
95
+
- "Community manager"
88
96
- "Designer"
89
97
- "Developer"
90
98
- "Data scientist"
91
99
- "Educator"
100
+
- "Extension developer/maintainer"
92
101
- "Technical writer"
93
-
- "Community manager"
94
102
- "Testing engineer"
95
-
- "Extension developer/maintainer"
96
103
97
104
- title: "What documentation engines do you use?"
98
105
multiple: true
99
106
other: true
100
107
choices:
101
-
- "MyST"
108
+
- "Astro"
102
109
- "Docusaurus"
103
-
- "Mkdocs"
110
+
- "Eleventy"
111
+
- "Hugo"
104
112
- "JupyterBook"
113
+
- "Mkdocs"
114
+
- "MyST"
115
+
- "Nikola"
116
+
- "Pelican"
105
117
- "Sphinx"
106
118
- "None"
107
119
- "I don’t know"
@@ -110,27 +122,41 @@ questions:
110
122
multiple: true
111
123
other: true
112
124
choices:
125
+
- "Cloudflare Pages"
126
+
- "DigitalOcean"
113
127
- "GitHub Pages"
128
+
- "Hetzner"
114
129
- "Netlify"
115
130
- "Read The Docs"
116
-
- "My institution has its own deployment"
131
+
- "Render"
132
+
- "Vercel"
133
+
- "Vultr"
134
+
- "We have our own deployment"
135
+
- "As a part of an existing website"
136
+
- "I don't know"
117
137
118
138
- title: "What markup language are you using in your documentation?"
119
139
multiple: true
120
140
other: true
121
141
choices:
122
-
- "Markdown"
142
+
- "AsciiDoc"
143
+
- "Confluence/Jira"
144
+
- "Markdown - CommonMark"
145
+
- "Markdown - GitHub Flavored Markdown"
146
+
- "Markdown - MyST"
123
147
- "reStructuredText"
148
+
- "TeX"
149
+
- "XML/DITA"
124
150
- "I don’t know"
125
151
126
152
- title: "What markup language are you using in your docstrings?"
127
153
multiple: true
128
154
other: true
129
155
choices:
156
+
- "Google format"
130
157
- "Markdown"
131
-
- "reStructuredText"
132
158
- "Numpydoc format"
133
-
- "Google format"
159
+
- "reStructuredText"
134
160
- "I don’t know"
135
161
136
162
- title:
@@ -139,19 +165,19 @@ questions:
139
165
other: true
140
166
choices:
141
167
- "Ease of use"
168
+
- "Frequent updates"
142
169
- "Performance"
143
170
- "Stability"
144
-
- "Frequent updates"
145
171
- "Variety of features"
146
172
147
173
- title: "Why did you choose the engine you use for your documentation?"
148
174
multiple: true
149
175
other: true
150
176
choices:
151
177
- "Ease of use"
178
+
- "Frequent updates"
152
179
- "Performance"
153
180
- "Stability"
154
-
- "Frequent updates"
155
181
- "Variety of features"
156
182
- "Other projects in my ecosystem were using it"
157
183
- "It was chosen by others on the project"
@@ -178,16 +204,17 @@ questions:
178
204
- title: "What is the main reason you use Sphinx?"
179
205
other: true
180
206
choices:
181
-
- "Python API documentation generation (docstrings)"
182
-
- "Narrative documentation"
183
-
- "Educational materials"
207
+
- "API documentation generation from Python docstrings"
208
+
- "Being able to cross-reference other pages/sections across one or multiple sites ('intersphinx')"
209
+
- "Add functionality through extensions"
184
210
- "Other projects in my ecosystem were using Sphinx"
185
211
- "Someone on my team knew how to use Sphinx"
186
212
- "I joined a project that was already using Sphinx"
187
213
- "Sphinx’s ease of use"
188
214
- "Sphinx’s performance"
189
215
- "Sphinx’s stability"
190
216
- "Sphinx’s release schedule"
217
+
191
218
192
219
- title: "Does your project use custom Sphinx extensions?"
193
220
choices:
@@ -202,32 +229,30 @@ questions:
202
229
choices:
203
230
- "Whatever comes with Sphinx by default"
204
231
- "Alabaster"
205
-
- "Read The Docs"
206
-
- "Pydata Sphinx Theme"
232
+
- "Furo"
207
233
- "Material design"
234
+
- "Pydata Sphinx Theme"
235
+
- "Python Docs Sphinx Theme"
236
+
- "Read The Docs"
237
+
- "Shibuya"
238
+
- "Sphinx Awesome Theme"
239
+
- "Sphinx Book Theme"
240
+
- "Sphinx Bootstrap Theme"
241
+
- "Sphinx Immaterial"
208
242
- "Something else/I don’t know"
209
243
210
244
- title: "In which formats do you publish your documentation with sphinx?"
211
245
multiple: true
212
246
other: true
213
247
choices:
248
+
- "EPUB"
214
249
- "HTML"
250
+
- "JSON serialisation"
251
+
- "manpages / manual pages"
215
252
- "PDF"
216
-
- "EPUB"
217
-
218
-
- title: "How comfortable do you feel when working with docutils?"
219
-
choices:
220
-
- "Very comfortable"
221
-
- "Comfortable"
222
-
- "Neutral"
223
-
- "Uncomfortable"
224
-
- "Very uncomfortable"
225
-
- "I don't know or don't work with docutils"
226
-
227
-
- title:
228
-
"What is the biggest challenge you face when searching for documentation
229
-
on Sphinx internals?"
230
-
type: long_text
253
+
- "Plain text"
254
+
- "Texinfo"
255
+
- "XML"
231
256
232
257
- title:
233
258
"Please rank the issues you face when working with Sphinx from 1 (most
@@ -238,11 +263,11 @@ questions:
238
263
should resources be allocated."
239
264
type: ranking
240
265
choices:
241
-
- "reStructuredText syntax is too complicated"
242
-
- "Sphinx is missing features I want"
266
+
- "No native support for Markdown"
243
267
- "Performance issues"
268
+
- "reStructuredText syntax is too complicated"
244
269
- "Sphinx breaks too often"
245
-
- "No native support for Markdown"
270
+
- "Sphinx is missing features I want"
246
271
247
272
- title: "Are there any other issues you face when working with Sphinx?"
0 commit comments