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

OptionDetails
rootThe root directory all paths are relative to
codePath for code output
docsPath for documentation output
filesList of files to process
entrypointBlock name to be used as entrypoint. Optional. Uses unnamed entrypoints if not present
code_filesFiles or glob patterns for files to copy to the code output. Optional. See Copying files
code_pathsManipulation of code copy paths. Optional. See Copying files
doc_filesFiles or glob patterns for files to copy to the documentation output. Optional. See Copying files
doc_pathsManipulation of documentation copy paths. Optional. See Copying files