forks/apenwarr-redo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
apenwarr-redo/mkdocs.yml

35 lines
1.2 KiB
YAML
Raw Normal View History

First cookbook example for the docs: Hello World in C.
2018-11-24 14:36:02 -05:00
site_name: "redo: a recursive build system"
Generate a basic documentation website with the mkdocs toolkit. No content yet other than man pages. To make the man pages render nicely in mkdocs, I removed the static %-headers and put the code for them into default.md.tmp.do instead. That way, the raw input redo-*.md files will look right in mkdocs.
2018-11-15 23:59:22 -05:00
theme: readthedocs
Move mkdocs.yml into root directory, so readthedocs.org will work.
2018-11-16 01:14:15 -05:00
docs_dir: Documentation
site_dir: website
Generate a basic documentation website with the mkdocs toolkit. No content yet other than man pages. To make the man pages render nicely in mkdocs, I removed the static %-headers and put the code for them into default.md.tmp.do instead. That way, the raw input redo-*.md files will look right in mkdocs.
2018-11-15 23:59:22 -05:00
strict: true
Even more doc cleanups.
2018-11-26 17:32:19 -05:00
repo_url: https://github.com/apenwarr/redo
edit_uri: edit/master/Documentation
First cookbook example for the docs: Hello World in C.
2018-11-24 14:36:02 -05:00
extra_javascript:
- fetchcode.js
Generate a basic documentation website with the mkdocs toolkit. No content yet other than man pages. To make the man pages render nicely in mkdocs, I removed the static %-headers and put the code for them into default.md.tmp.do instead. That way, the raw input redo-*.md files will look right in mkdocs.
2018-11-15 23:59:22 -05:00
pages:
- Introduction: index.md
Refactor the huge README.md into the more structured mkdocs. I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
2018-11-16 03:13:33 -05:00
- Getting Started: GettingStarted.md
Even more doc cleanups.
2018-11-26 17:32:19 -05:00
- Contributing.md
First cookbook example for the docs: Hello World in C.
2018-11-24 14:36:02 -05:00
- Cookbook:
Even more doc cleanups.
2018-11-26 17:32:19 -05:00
- 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
Docs/cookbook: add an R + latex example. This shows how to dynamically generate a plot in R+ggplot2, then embed it into a latex document, and compile it to pdf, all with proper autodependencies.
2018-11-28 14:04:12 -05:00
- R plots and LaTeX to pdf (side effects, multiple outputs, autodepends): cookbook/latex/index.md
Refactor the huge README.md into the more structured mkdocs. I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
2018-11-16 03:13:33 -05:00
- FAQ:
- Basics: FAQBasics.md
- Semantics: FAQSemantics.md
- Interop with make: FAQInterop.md
- Parallel Builds: FAQParallel.md
- Implementation Details: FAQImpl.md
Cookbook: add an example of using default.do for text processing.
2018-11-26 13:10:29 -05:00
- 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
Reference in a new issue Copy permalink