apenwarr-redo/mkdocs.yml
Avery Pennarun 01497f55e9 mkdocs: enforce sufficiently new version, and use mkdocs-exclude.
We want to use the mkdocs-exclude plugin, which lets us exclude
particular files from the output directory.  But plugins aren't
available in the debian-stable version of mkdocs, so ensure that we're
running a sufficiently new version.  If we aren't, gracefully just skip
building the documentation.
2019-01-08 01:33:47 -05:00

50 lines
1.4 KiB
YAML

site_name: "redo: a recursive build system"
theme: readthedocs
docs_dir: docs
site_dir: docs.out
strict: true
repo_url: https://github.com/apenwarr/redo
edit_uri: edit/master/docs
extra_javascript:
- fetchcode.js
extra_css:
- extra_style.css
plugins:
- exclude:
glob:
- "t/*"
- "*.tmp"
- "*.gz"
- "*.tar"
- "*.pdf"
- "*.ps"
- "*.1"
regex:
- ".*~"
nav:
- Introduction: index.md
- Getting Started: GettingStarted.md
- Contributing.md
- Roadmap.md
- Cookbook:
- Hello World (hello.do, redo-ifchange): cookbook/hello/index.md
- Text processing example (default.do, redo-whichdo, redo-always, redo-stamp): cookbook/defaults/index.md
- R plots and LaTeX to pdf (side effects, multiple outputs, autodepends): cookbook/latex/index.md
- FAQ:
- Basics: FAQBasics.md
- Semantics: FAQSemantics.md
- Interop with make: FAQInterop.md
- Parallel Builds: FAQParallel.md
- Implementation Details: FAQImpl.md
- Reference Manual:
- redo(1): redo.md
- redo-ifchange(1): redo-ifchange.md
- redo-ifcreate(1): redo-ifcreate.md
- redo-always(1): redo-always.md
- redo-stamp(1): redo-stamp.md
- redo-sources(1): redo-sources.md
- redo-targets(1): redo-targets.md
- redo-ood(1): redo-ood.md
- redo-whichdo(1): redo-whichdo.md
- redo-log(1): redo-log.md