Spoofax Documentation

This is the repository for the Spoofax documentation. This documentation uses [Material for MkDocs].

Quick Start

To build the pages and see edits live using Docker:

make

Or using Python 3, creating and activating a virtual environment using virtualenv (the more featureful ancestor of venv, install with python3 -m pip install virtualenv):

virtualenv venv                 # Create a virtual environment
source venv/bin/activate        # Activate the virtual environment

pip install -r requirements.txt # Install dependencies
mkdocs serve                    # Serve the documentation

deactivate                      # Deactivate the virtual environment

Navigate to localhost:8000 to see the documentation. The local documentation is automatically reloaded when changes occur. Changes pushed to the main branch are automatically deployed to Github Pages.

Adding Pages

New pages should be added to the mkdocs.yml nav element. The first page mentioned under a section header should be some **/index.md without a label, and will be used as the index page for that section.

Updating Dependencies

Using the pip-check-updates tool, you can check the versions of the dependencies. Install in a virtual environment:

pip install pip-check-updates

Usage:

pcu requirements.txt

And update the dependencies to their latest versions using:

pcu -u requirements.txt