Welcome to the sphinxcontrib-proof documentation¶
This sphinx extension provides some directives to typeset theorems, proofs, etc. to both HTML and LaTeX builders.
Example¶
Consider the following text.
Definition 1 (Right triangle)A right triangle is a triangle in which one angle is a right angle.
Theorem 2 (Pythagorean theorem)In a Right triangle, the square of the hypotenuse is equal to the sum of the squares of the other two sides.
ProofThe proof is left to the reader.
You can label and reference definition and theorems (e.g. theorem 2). You can also reference proofs (see the proof of the Pythagorean theorem).
To produce the above result, the following code was used (as well as this CSS file, and the relevant configuration options).
.. _righttriangle:
.. proof:definition:: Right triangle
A *right triangle* is a triangle in which one angle is a right angle.
.. _pythagorean:
.. proof:theorem:: Pythagorean theorem
In a :ref:`righttriangle`, the square of the hypotenuse is equal to the sum of the squares of the other two sides.
.. _proof:
.. proof:proof::
The proof is left to the reader.
You can label and reference definition and theorems (e.g. :numref:`theorem {number} <pythagorean>`). You can also reference proofs (see the :ref:`proof of the Pythagorean theorem <proof>`).
Download and Install¶
See the main project page for instructions, and changelog.