Paths
Section paths
of a project's Yarner.toml
contains configuration on which files to process and to copy.
Overview
The default paths
section as generated by yarner init
looks like this (comments removed):
[paths]
root = "."
code = "code/"
docs = "docs/"
files = ["README.md"]
# entrypoint = "Main"
# code_files = ["**/*.rs"]
# code_paths = ["_"]
# doc_files = ["**/*.png", "**/*.jpg"]
# doc_paths = ["_"]
Options
Option | Details |
---|---|
root | The root directory all paths are relative to |
code | Path for code output |
docs | Path for documentation output |
files | List of files to process |
entrypoint | Block name to be used as entrypoint. Optional. Uses unnamed entrypoints if not present |
code_files | Files or glob patterns for files to copy to the code output. Optional. See Copying files |
code_paths | Manipulation of code copy paths. Optional. See Copying files |
doc_files | Files or glob patterns for files to copy to the documentation output. Optional. See Copying files |
doc_paths | Manipulation of documentation copy paths. Optional. See Copying files |