Skip to content

Commit 7c4fff8

Browse files
isabela-pfIsabela Presedo-FloydAA-Turner
authored
2025 Survey Draft Updates (#2)
Co-authored-by: Isabela Presedo-Floyd <irpf@Isabelas-MacBook-Pro.local> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
1 parent f1f90e8 commit 7c4fff8

File tree

1 file changed

+69
-44
lines changed

1 file changed

+69
-44
lines changed

surveys/sphinx-survey-2025.yml

Lines changed: 69 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Copyright (c) 2025, Quansight Inc.
22

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+
39
title: "Sphinx Survey 2025"
410
questions:
511
- title: "Sphinx Usage Survey 2025"
@@ -31,19 +37,20 @@ questions:
3137
- "I build extensions for Sphinx"
3238
- "I maintain a Sphinx theme"
3339
- "I contribute to Sphinx"
40+
- "None of the above"
3441

3542
- 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"
4754

4855
- title: "Do you most often work on a team or independently?"
4956
other: true
@@ -85,23 +92,28 @@ questions:
8592
multiple: true
8693
other: true
8794
choices:
95+
- "Community manager"
8896
- "Designer"
8997
- "Developer"
9098
- "Data scientist"
9199
- "Educator"
100+
- "Extension developer/maintainer"
92101
- "Technical writer"
93-
- "Community manager"
94102
- "Testing engineer"
95-
- "Extension developer/maintainer"
96103

97104
- title: "What documentation engines do you use?"
98105
multiple: true
99106
other: true
100107
choices:
101-
- "MyST"
108+
- "Astro"
102109
- "Docusaurus"
103-
- "Mkdocs"
110+
- "Eleventy"
111+
- "Hugo"
104112
- "JupyterBook"
113+
- "Mkdocs"
114+
- "MyST"
115+
- "Nikola"
116+
- "Pelican"
105117
- "Sphinx"
106118
- "None"
107119
- "I don’t know"
@@ -110,27 +122,41 @@ questions:
110122
multiple: true
111123
other: true
112124
choices:
125+
- "Cloudflare Pages"
126+
- "DigitalOcean"
113127
- "GitHub Pages"
128+
- "Hetzner"
114129
- "Netlify"
115130
- "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"
117137

118138
- title: "What markup language are you using in your documentation?"
119139
multiple: true
120140
other: true
121141
choices:
122-
- "Markdown"
142+
- "AsciiDoc"
143+
- "Confluence/Jira"
144+
- "Markdown - CommonMark"
145+
- "Markdown - GitHub Flavored Markdown"
146+
- "Markdown - MyST"
123147
- "reStructuredText"
148+
- "TeX"
149+
- "XML/DITA"
124150
- "I don’t know"
125151

126152
- title: "What markup language are you using in your docstrings?"
127153
multiple: true
128154
other: true
129155
choices:
156+
- "Google format"
130157
- "Markdown"
131-
- "reStructuredText"
132158
- "Numpydoc format"
133-
- "Google format"
159+
- "reStructuredText"
134160
- "I don’t know"
135161

136162
- title:
@@ -139,19 +165,19 @@ questions:
139165
other: true
140166
choices:
141167
- "Ease of use"
168+
- "Frequent updates"
142169
- "Performance"
143170
- "Stability"
144-
- "Frequent updates"
145171
- "Variety of features"
146172

147173
- title: "Why did you choose the engine you use for your documentation?"
148174
multiple: true
149175
other: true
150176
choices:
151177
- "Ease of use"
178+
- "Frequent updates"
152179
- "Performance"
153180
- "Stability"
154-
- "Frequent updates"
155181
- "Variety of features"
156182
- "Other projects in my ecosystem were using it"
157183
- "It was chosen by others on the project"
@@ -178,16 +204,17 @@ questions:
178204
- title: "What is the main reason you use Sphinx?"
179205
other: true
180206
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"
184210
- "Other projects in my ecosystem were using Sphinx"
185211
- "Someone on my team knew how to use Sphinx"
186212
- "I joined a project that was already using Sphinx"
187213
- "Sphinx’s ease of use"
188214
- "Sphinx’s performance"
189215
- "Sphinx’s stability"
190216
- "Sphinx’s release schedule"
217+
191218

192219
- title: "Does your project use custom Sphinx extensions?"
193220
choices:
@@ -202,32 +229,30 @@ questions:
202229
choices:
203230
- "Whatever comes with Sphinx by default"
204231
- "Alabaster"
205-
- "Read The Docs"
206-
- "Pydata Sphinx Theme"
232+
- "Furo"
207233
- "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"
208242
- "Something else/I don’t know"
209243

210244
- title: "In which formats do you publish your documentation with sphinx?"
211245
multiple: true
212246
other: true
213247
choices:
248+
- "EPUB"
214249
- "HTML"
250+
- "JSON serialisation"
251+
- "manpages / manual pages"
215252
- "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"
231256

232257
- title:
233258
"Please rank the issues you face when working with Sphinx from 1 (most
@@ -238,11 +263,11 @@ questions:
238263
should resources be allocated."
239264
type: ranking
240265
choices:
241-
- "reStructuredText syntax is too complicated"
242-
- "Sphinx is missing features I want"
266+
- "No native support for Markdown"
243267
- "Performance issues"
268+
- "reStructuredText syntax is too complicated"
244269
- "Sphinx breaks too often"
245-
- "No native support for Markdown"
270+
- "Sphinx is missing features I want"
246271

247272
- title: "Are there any other issues you face when working with Sphinx?"
248273
type: long_text

0 commit comments

Comments
 (0)