Codebase

This is a quick documentation-draft for the parts of the codebase which is not directly user-facing. That is, the argumenting-parsing of the Cli, the logic-dispatch of the Compiler, and the encapsulation of Entities in the Model.

Toolbox

The toolbox and Makefile-helper requires that make is available. See the utilities provided by running:

make help

This should output:

make[1]: Entering directory '/home/runner/work/yace/yace'
Usage:
 
  make help          ; Brief target description
  make help-verbose  ; Verbose target descriptions
  make [target]      ; Invoke the given 'target'
 
Targets:
 
all               ; Do all: uninstall clean install docs
bump              ; run code format (style, code-conventions and language-integrity) on all files
clean             ; clean build artifacts (build, dist, output)
coverage          ; Run emitter with coverage
default           ; invoke: 'make uninstall', 'make install'
docker            ; drop into a docker instance with the repository bind-mounted at /tmp/yace
docs              ; generate documentation (command-output, section-gen, HTML) and open the HTML
docs-build        ; generate documentation
docs-build-prep   ; Install Sphinx Doc. in a pipx-venv along with jinja2, pygments-ansi-color, and sphinxcontrib-gtagjs
docs-gen-entities ; Generate documentation of IR entities
docs-kmdo         ; Generate command output using kmdo
docs-view         ; open the HTML version documentation
example           ; Run the example
format            ; run code format (style, code-conventions and language-integrity) on staged changes
format-all        ; run code format (style, code-conventions and language-integrity) on all files
help              ; Print the description of every target
install           ; install using pipx and the Python interpreter resolve to by 'python3'
release-build     ; Produce Python distribution (sdist, bdist_wheel)
release-upload    ; Produce + Upload Python distribution (sdist, bdist_wheel)
uninstall         ; uninstall via pipx
view              ; Inspect generated code
make[1]: Leaving directory '/home/runner/work/yace/yace'

TOC