This repository contains the official documentation for the Balzac programming language. Balzac is a domain-specific language designed for writing Bitcoin smart contracts. The documentation is built using Sphinx and provides comprehensive information about the language's syntax, features, and usage.
- Python 3.x
- pip (Python package manager)
- Clone this repository:
git clone https://github.com/balzac-lang/balzac-doc.git
cd balzac-doc- Install dependencies:
pip install sphinx pygments- Install the Balzac lexer and build the documentation:
make full-build- Start a local server to view the documentation:
make serverThe documentation will be available at http://localhost:8000
Run make to see all available commands. Here are the most commonly used ones:
make build # Build the documentation
make clean # Clean the documentation
make html # Build HTML documentation
make latexpdf # Build PDF documentation
make linkcheck # Check all external linksFor a complete list of available commands, run make without arguments.
Build the Docker image (assuming the documentation is in build/html):
docker build -t balzaclang/balzac-doc:latest .Run the container on port 8080:
docker run --rm --name balzac-doc -p 8080:80 balzaclang/balzac-doc:latestAccess the documentation at http://localhost:8080
Pull the latest image from DockerHub:
docker pull balzaclang/balzac-doc:latestAvailable architectures:
- linux/amd64
- linux/arm/v7
- linux/arm64
We welcome contributions to the documentation! Please feel free to submit issues or pull requests to help improve the documentation.