ZSLICEDOCS

Documentation

zslice documentation

For people who slice with zslice

For developers who use the library

The app

For developers who change or extend zslice

Documentation

The site at https://zslice.beetlebug.org/docs.html comes from these Markdown files. docs/build.py writes the pages into docs/, with one folder for each page. It needs only Python 3.

python3 docs/build.py

Run it after a change to a Markdown file, and commit the pages with the change. At the end, the script checks each link of the site. It stops with an error for a link to a file or an anchor that does not exist. A push to master that changes docs/ publishes the site (.github/workflows/pages.yml).

To add a page, add its Markdown file to SOURCES in docs/build.py. The script stops with an error for a Markdown file in docs/ that has no page.