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, assumption and notation directives.
- 15 directive types for mathematical proofs and theorems
- Automatic numbering of directives
- optional shared numbering of groups of directives
- Cross-referencing support via
prf:refrole - 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:
- two theme options
- directive title format customization
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"]
...See the Sphinx Proof documentation for more information.
We welcome all contributions! See the EBP Contributing Guide for general details, and below for guidance specific to sphinx-proof.