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 `.. code-block:: python` directive in a reST document?

1. What is the purpose of the `.. code-block:: python` directive in a reST document?
2. What documentation convention/style do docstrings typically need to follow for Sphinx's `napoleon` extension to parse them correctly?
3. What is the purpose of Sphinx's cross-reference roles like `:func:`, `:class:`, and `:ref:`?
4. What does `sphinx-build` (or the common `make html` wrapper) actually do?
5. What does Sphinx's `napoleon` + `autodoc` combination typically automate as part of a documentation CI/publishing pipeline?
6. What is Read the Docs, and how does it typically relate to a Sphinx-based project?
7. What is a common reason a documentation team might specifically choose Sphinx over a simpler static-site generator for API reference documentation?
8. What is a reasonable trade-off consideration between Sphinx and a lighter-weight documentation tool like MkDocs for a project that is primarily prose-based guides rather than deep API reference material?
9. What is the purpose of the `nitpicky` (`-n` flag / `nitpicky = True` in conf.py) build option in Sphinx?
10. What is the purpose of the `toctree` directive in a Sphinx document?
11. What is Sphinx?
12. What is a Sphinx "domain," e.g. the Python domain providing directives like `.. py:function::` and roles like `:py:func:`?

More quizzes