Skip to main content

A Sphinx extension for producing exercises and solutions.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_exercise-1.2.1.tar.gz (572.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_exercise-1.2.1-py3-none-any.whl (46.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_exercise-1.2.1.tar.gz.

File metadata

  • Download URL: sphinx_exercise-1.2.1.tar.gz
  • Upload date:
  • Size: 572.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for sphinx_exercise-1.2.1.tar.gz
Algorithm Hash digest
SHA256 3cfb46b8fc4bbc8e6955f0064128a54d3f3895579591a5219d891eedf11c7108
MD5 2655971672e563797cc3b34ba1d961a6
BLAKE2b-256 d1d5709f31d46b601caa3301ab8551c67351e1a483105805a6065bf8a033c5f0

See more details on using hashes here.

File details

Details for the file sphinx_exercise-1.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_exercise-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c8e5e470f5a3654a52f74528de5fade87df055bd0eacf4f607d355ea2558ff04
MD5 2f18ef300d21c3f9416f3d0ff98b9e7b
BLAKE2b-256 4d95af014c5eb8e804103471bcf3204ebfe6a674d8bae07e5c2b691c09183b9f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page