index.md

sphinx-proof

:hidden:

install
syntax
options
internationalization
testing
zreferences

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.

Features:

1. 15 directive types - all automatically numbered with cross-referencing support
2. 33 languages supported - complete internationalization for global academic communities
3. Flexible options - supports class, label, and nonumber directive options
4. Easy referencing - use the prf:ref role to reference any directive
5. Customizable themes - includes default and minimal theme options

(getting-started)=

Getting Started

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

pip install sphinx-proof

Jupyter-Book Project

Add sphinx_proof to your extra_extensions config in _config.yml

sphinx:
  extra_extensions:
    - sphinx_proof

you may then use jb build <project> and the extension will be used by your JupyterBook project.

Sphinx Project

Add sphinx_proof to your sphinx extensions in the conf.py

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

you may then build using make html and the extension will be used by your Sphinx project.