Skip to content

executablebooks/sphinx-exercise

sphinx-exercise

Documentation Status Github-CI Coverage Status

An exercise extension for Sphinx.

This package contains a Sphinx extension for producing exercise and solution directives.

Features

  • Automatic numbering for exercises and solutions
  • Cross-referencing support with ref and numref roles
  • Internationalization support for 27 languages including Chinese, Japanese, Korean, Arabic, Hindi, and more
  • HTML and PDF output support
  • Gated directive syntax for including executable code and complex content
  • Customizable styling with class options and hidden directive support

Get started

To get started with sphinx-exercise, first install it through pip:

pip install sphinx-exercise

then, add sphinx_exercise to your sphinx extensions in the conf.py

...
extensions = ["sphinx_exercise"]
...

Documentation

See the Sphinx Exercise documentation for more information.

Contributing

We welcome all contributions! See the EBP Contributing Guide for general details, and below for guidance specific to sphinx-exercise.

About

A Sphinx extension for producing exercise and solution directives.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 7