forked from ExtraMojo/ExtraMojo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmodo.yaml
72 lines (54 loc) · 1.67 KB
/
modo.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# Input files as generated by `mojo doc`.
# If a single directory is given, it is processed recursively.
input:
- docs/src
# Source directories to monitor when running in watch mode.
source:
- ExtraMojo
# Full URLs of package sources. Used to create source links.
source-url:
ExtraMojo: https://github.com/ExtraMojo/ExtraMojo/blob/main/ExtraMojo
# Output directory.
output: docs/site/content
# Output directory for doc-tests.
# Remove or set to "" to disable doc-tests.
tests: docs/test
# Output format. One of (plain|hugo|mdbook).
format: hugo
# Re-structure docs according to package re-exports.
exports: true
# Use shortened cross-ref link labels.
short-links: true
# Report missing docstings and coverage.
report-missing: true
# Break with error on any warning.
strict: false
# Run without generating any output files.
dry-run: false
# Build for systems that are not case-sensitive regarding file names.
# Appends hyphen (-) to capitalized file names.
case-insensitive: false
# Directories to scan for templates to overwrite builtin templates.
templates: [docs/templates]
# Bash scripts to run before build as well as test.
pre-run:
- |
echo Running 'mojo doc'...
magic run mojo doc -o docs/src/ExtraMojo.json ExtraMojo
echo Done.
# Bash scripts to run before build.
pre-build: []
# Bash scripts to run before test.
# Also runs before build if 'tests' is given.
pre-test: []
# Bash scripts to run after test.
# Also runs after build if 'tests' is given.
post-test:
- |
echo Running 'mojo test'...
magic run mojo test -I . docs/test
echo Done.
# Bash scripts to run after build.
post-build: []
# Bash scripts to run after build as well as test.
post-run: []