Benchmark Development

The documentation on this page applies to internal Xylok command and benchmark development.

PP Docs

If working on the post-processing docs, run:

task benchmarks:pp-docs-dev

Then access the docs at http://localhost:8003/. If running XSS in dev mode, it proxies to this server from https://localhost/pp/docs/.

Docs are written in ReStructuredText using Sphinx.

Updating Python docstrings is often not caught by the auto-build dev server (sphinx-autobuild), so you may need to restart the task to see changes. Changes to .rst files are reliably detected.

Bedit

bedit --help

If you want to edit bedit itself, use the bedit-dev script to run bedit from your local repository.