Sphinx quiz

Test your Sphinx knowledge with a free interactive quiz — 19 questions with answers and explanations. No signup needed to play.

What is the purpose of the `toctree` directive in a Sphinx document?

1. What is the purpose of the `toctree` directive in a Sphinx document?
2. What is a common reason a documentation team might specifically choose Sphinx over a simpler static-site generator for API reference documentation?
3. What does `sphinx-build` (or the common `make html` wrapper) actually do?
4. What is `conf.py` in a Sphinx project?
5. What documentation convention/style do docstrings typically need to follow for Sphinx's `napoleon` extension to parse them correctly?
6. What is the purpose of the `nitpicky` (`-n` flag / `nitpicky = True` in conf.py) build option in Sphinx?
7. What is the significance of Sphinx supporting Markdown source files (via the `MyST-Parser` extension) in addition to its traditional reStructuredText format?
8. What themes does Sphinx support, and what does changing the theme actually affect?
9. What is the purpose of Sphinx's `autodoc` extension?
10. What is the purpose of the `.. code-block:: python` directive in a reST document?
11. What does `sphinx-apidoc` do, as distinct from the `autodoc` extension itself?
12. What is reStructuredText (reST), and what is its relationship to Sphinx?

More quizzes