Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.65 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.65 KB

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.

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.