Skip to content

executablebooks/sphinx-proof

sphinx-proof

Documentation Status Github-CI Coverage Status pre-commit.ci status

A proof extension for Sphinx.

This package contains a Sphinx extension for producing proof, theorem, axiom, lemma, definition, criterion, remark, conjecture, corollary, algorithm, example, property, observation, proposition and assumption directives.

Features

  • 15 directive types for mathematical proofs and theorems
  • Automatic numbering of directives
  • Cross-referencing support via prf:ref role
  • 33 languages supported - Complete translations for all directive types in English plus 32 additional languages (Arabic, Bengali, Bulgarian, Chinese, Czech, Danish, Dutch, Finnish, French, German, Greek, Hebrew, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Malay, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Swedish, Thai, Turkish, Ukrainian, Urdu, Vietnamese)
  • Customizable styling with multiple theme options

Get started

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

pip install sphinx-proof

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

...
extensions = ["sphinx_proof"]
...

Documentation

See the Sphinx Proof documentation for more information.

Contributing

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

About

A Sphinx extension for producing proof, theorem, lemma, definition, remark, conjecture, corollary and algorithm directives.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 16