Skip to content

Commit e5eec05

Browse files
AA-TurnerAA-Turner
authored
Import sphinx-survey.yml (#1)
Taken as at 2025-04-03, from commit af9d384d0db2d68626868c4e48adcd9d8d86b229 of https://github.com/Quansight-Labs/typeform-yaml-survey, wrapped to 80 characters. Authored-By: Tania Allard <taniar.allard@gmail.com> Authored-By: M Bussonnier <bussonniermatthias@gmail.com> Authored-By: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Authored-By: Isabela Presedo-Floyd <50221806+isabela-pf@users.noreply.github.com> Authored-By: Melissa Weber Mendonça <melissawm@gmail.com>
1 parent e1bfa96 commit e5eec05

File tree

1 file changed

+259
-0
lines changed

1 file changed

+259
-0
lines changed

‎surveys/sphinx-survey-2025.yml

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
# Copyright (c) 2025, Quansight Inc.
2+
3+
title: "Sphinx Survey 2025"
4+
questions:
5+
- title: "Sphinx Usage Survey 2025"
6+
type: statement
7+
description: |
8+
Sphinx Documentation User Survey 2025
9+
10+
Help the Sphinx community understand who is using Sphinx, how they are
11+
using it, and how well it supports the people using it. We will use this
12+
information to aid community discussion about improvements to Sphinx.
13+
14+
Results will be public with identifying information removed. Open text
15+
field questions may be quoted, but will not be shown in full.
16+
17+
This survey is run by the Sphinx community; survey data will be deleted
18+
from any private accounts once made public. If you have any questions,
19+
reach out to [Contact to be determined].
20+
21+
- title: "Tell us about you"
22+
description:
23+
"First, we'd like to know about how you work and what tools you use."
24+
type: statement
25+
26+
- title: "What is your relation to the Sphinx project?"
27+
multiple: true
28+
choices:
29+
- "I read documentation that is built with Sphinx"
30+
- "I use Sphinx to build documentation"
31+
- "I build extensions for Sphinx"
32+
- "I maintain a Sphinx theme"
33+
- "I contribute to Sphinx"
34+
35+
- 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"
47+
48+
- title: "Do you most often work on a team or independently?"
49+
other: true
50+
choices:
51+
- "I most often work on projects independently"
52+
- "I most often work on projects as part of a team"
53+
- "I spend about equal time working on projects independently as I do on
54+
a team"
55+
- "Prefer not to answer"
56+
57+
- title: "How many years have you been using Python for?"
58+
type: number
59+
60+
- title: "Which Python ecosystem do you feel most aligned with?"
61+
multiple: true
62+
other: true
63+
choices:
64+
- "Data Science"
65+
- "Machine Learning"
66+
- "Web"
67+
- "Scientific Python"
68+
- "Infrastructure"
69+
- "Prefer not to answer"
70+
71+
- title: "For how many years have you been using documentation tools?"
72+
type: number
73+
74+
- title: "In which of the following contexts do you use documentation tools?"
75+
multiple: true
76+
other: true
77+
choices:
78+
- "As a part of my full-time job"
79+
- "As a part of my part-time, contract, or other employment"
80+
- "As a part of a side or non-paid project"
81+
- "I do not use documentation tools"
82+
83+
- title:
84+
"How would you identify your role in your documentation-related projects?"
85+
multiple: true
86+
other: true
87+
choices:
88+
- "Designer"
89+
- "Developer"
90+
- "Data scientist"
91+
- "Educator"
92+
- "Technical writer"
93+
- "Community manager"
94+
- "Testing engineer"
95+
- "Extension developer/maintainer"
96+
97+
- title: "What documentation engines do you use?"
98+
multiple: true
99+
other: true
100+
choices:
101+
- "MyST"
102+
- "Docusaurus"
103+
- "Mkdocs"
104+
- "JupyterBook"
105+
- "Sphinx"
106+
- "None"
107+
- "I don’t know"
108+
109+
- title: "Where do you deploy your documentation pages?"
110+
multiple: true
111+
other: true
112+
choices:
113+
- "GitHub Pages"
114+
- "Netlify"
115+
- "Read The Docs"
116+
- "My institution has its own deployment"
117+
118+
- title: "What markup language are you using in your documentation?"
119+
multiple: true
120+
other: true
121+
choices:
122+
- "Markdown"
123+
- "reStructuredText"
124+
- "I don’t know"
125+
126+
- title: "What markup language are you using in your docstrings?"
127+
multiple: true
128+
other: true
129+
choices:
130+
- "Markdown"
131+
- "reStructuredText"
132+
- "Numpydoc format"
133+
- "Google format"
134+
- "I don’t know"
135+
136+
- title:
137+
"Which of the following is most important to you in a documentation site?"
138+
multiple: true
139+
other: true
140+
choices:
141+
- "Ease of use"
142+
- "Performance"
143+
- "Stability"
144+
- "Frequent updates"
145+
- "Variety of features"
146+
147+
- title: "Why did you choose the engine you use for your documentation?"
148+
multiple: true
149+
other: true
150+
choices:
151+
- "Ease of use"
152+
- "Performance"
153+
- "Stability"
154+
- "Frequent updates"
155+
- "Variety of features"
156+
- "Other projects in my ecosystem were using it"
157+
- "It was chosen by others on the project"
158+
159+
- title:
160+
"Do you use Sphinx? (Whether working on the project, using it for another
161+
project, or developing Sphinx-extensions)"
162+
type: "yes_no_jump"
163+
ref: "use_sphinx"
164+
if_no_jump_to: arent_sphinx
165+
otherwise_jump_to: sphinx_years
166+
167+
- title:
168+
"If you aren’t using Sphinx for your documentation, please explain why
169+
you chose the one you are using"
170+
ref: "arent_sphinx"
171+
type: long_text
172+
always_jump_to: the_end
173+
174+
- title: "How many years have you been using Sphinx?"
175+
ref: sphinx_years
176+
type: number
177+
178+
- title: "What is the main reason you use Sphinx?"
179+
other: true
180+
choices:
181+
- "Python API documentation generation (docstrings)"
182+
- "Narrative documentation"
183+
- "Educational materials"
184+
- "Other projects in my ecosystem were using Sphinx"
185+
- "Someone on my team knew how to use Sphinx"
186+
- "I joined a project that was already using Sphinx"
187+
- "Sphinx’s ease of use"
188+
- "Sphinx’s performance"
189+
- "Sphinx’s stability"
190+
- "Sphinx’s release schedule"
191+
192+
- title: "Does your project use custom Sphinx extensions?"
193+
choices:
194+
- "My project is a custom Sphinx extension(s)"
195+
- "No, my project does not use custom Sphinx extensions"
196+
- "Yes, my project does use custom Sphinx extensions"
197+
- "I don’t know"
198+
199+
- title: "What theme(s) do you use? Select all that apply."
200+
multiple: true
201+
other: true
202+
choices:
203+
- "Whatever comes with Sphinx by default"
204+
- "Alabaster"
205+
- "Read The Docs"
206+
- "Pydata Sphinx Theme"
207+
- "Material design"
208+
- "Something else/I don’t know"
209+
210+
- title: "In which formats do you publish your documentation with sphinx?"
211+
multiple: true
212+
other: true
213+
choices:
214+
- "HTML"
215+
- "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
231+
232+
- title:
233+
"Please rank the issues you face when working with Sphinx from 1 (most
234+
important, I wish this was fixed yesterday) to 5 (least important, this
235+
can wait)."
236+
description:
237+
"That is to say, the issues you'd like to be fixed first, and where
238+
should resources be allocated."
239+
type: ranking
240+
choices:
241+
- "reStructuredText syntax is too complicated"
242+
- "Sphinx is missing features I want"
243+
- "Performance issues"
244+
- "Sphinx breaks too often"
245+
- "No native support for Markdown"
246+
247+
- title: "Are there any other issues you face when working with Sphinx?"
248+
type: long_text
249+
250+
- title: "If there are any features you wish Sphinx had, what would they be?"
251+
type: long_text
252+
253+
- title: "Thanks for your participation"
254+
ref: the_end
255+
type: statement
256+
description: |
257+
Add contact detail again, and maybe link to an open issue people can
258+
subscribe on github for when the results will be available.
259+
Likely on the typeform repository.

0 commit comments

Comments
 (0)