54 lines
1.8 KiB
TOML
54 lines
1.8 KiB
TOML
# A project file: one document built from several sources.
|
|
#
|
|
# make run CONFIG=docgen.project.example.toml CHECK=1
|
|
# make scaffold CONFIG=docgen.project.example.toml # a stub note for every spot
|
|
# python3 -m docgen run docgen.project.example.toml --list
|
|
#
|
|
# Every [extract.*] table is a book — a part of each output. Every [emit.*] table
|
|
# is an output made of all of them. Paths are relative to THIS FILE. Unknown keys
|
|
# are refused with a reason, never ignored.
|
|
#
|
|
# The other shape, a list of independent books, is docgen.example.toml.
|
|
|
|
[project]
|
|
name = "docgen-fixtures"
|
|
title = "docgen's own fixtures"
|
|
notes = "fixtures/notes" # notes/<book>/<page>.md lands above that page
|
|
build = ".docgen" # book artifacts; gitignore it
|
|
# reference = "../../" # the repo holding station/tools/modelgen, for OpenAPI
|
|
|
|
# A tree of Python. Several trees: [[extract.python]] with a `name` each.
|
|
[extract.python]
|
|
name = "extractors"
|
|
root = "extractors"
|
|
|
|
# A database schema, as `modelgen from-db` writes it. docgen reads the dump and
|
|
# never connects: `url = ...` is refused, since a URL in a committed file is a
|
|
# credential in a committed file.
|
|
[extract.db]
|
|
name = "schema"
|
|
schema = "fixtures/shop.json"
|
|
|
|
# An OpenAPI document. Needs pyyaml and the reference repo's modelgen; without
|
|
# them this book fails with a one-line reason and the others still build.
|
|
[extract.openapi]
|
|
name = "api"
|
|
spec = "fixtures/orders.yaml"
|
|
|
|
# Also available:
|
|
# [extract.code] root = "src", ext = [".cs", ".ts"] (tree-sitter)
|
|
# [extract.usage] har = "session.har"
|
|
|
|
[ops]
|
|
drop_stdlib = true
|
|
drop_builtins = true
|
|
|
|
[emit.notebook]
|
|
output = "out/project/notebook" # a directory: <name>.ipynb goes inside
|
|
theme = "lucid"
|
|
width = 960 # px — pages are split until each fits
|
|
|
|
[emit.minisite]
|
|
output = "out/project/minisite"
|
|
theme = "dark"
|