Skip to content

hrmacbeth/leanInk-sphinx-test

Repository files navigation

leanInk-sphinx-test

This is a small Sphinx project with Lean 4 code, for testing with Alectryon.

The Lean 4 file being tested is LeanSource/ModularArithmeticTheory.lean. See the original Lean 3 file here.

Running

alectryon LeanSource/ModularArithmeticTheory.lean --lake lakefile.lean

generates a single Alectryon-enabled HTML page for the file LeanSource/ModularArithmeticTheory.lean.

It is easy to convert back and forth between a Lean4 file with comments in RST format and an RST file with code snippets with .. lean4:: designation. The RST file source/ParityDivision/ModularArithmeticTheory-lean4.inc has been obtained from LeanSource/ModularArithmeticTheory.lean using Alectryon's utility for this (up to a few cosmetic changes).

The Alectryon directives .. lean4:: are not currently understood by Sphinx. Sphinx can display non-interactive code blocks with the .. code-block:: designation. The file source/ParityDivision/ModularArithmeticTheory-code-block.inc has been obtained from source/ParityDivision/ModularArithmeticTheory-lean4.inc by changing all occurrences of .. lean4:: to .. code-block::. This is enough to give a non-Alectryon-enabled preview of how the project should look. Install Sphinx and then run

make html

About

Small Sphinx project with Lean 4 code, for testing with Alectryon

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published