apenwarr-redo/mkdocs.yml

site_name: the _redo_ build system
theme: readthedocs
docs_dir: Documentation
site_dir: website
strict: true

pages:
  - Introduction: index.md
  - Getting Started: GettingStarted.md
  - FAQ:
    - Basics: FAQBasics.md
    - Semantics: FAQSemantics.md
    - Interop with make: FAQInterop.md
    - Parallel Builds: FAQParallel.md
    - Implementation Details: FAQImpl.md
  - Contributing.md
  - Reference:
    - Manual Pages:
      - redo: redo.md
      - redo-ifchange: redo-ifchange.md
      - redo-ifcreate: redo-ifcreate.md
      - redo-always: redo-always.md
      - redo-stamp: redo-stamp.md
      - redo-sources: redo-sources.md
      - redo-targets: redo-targets.md
      - redo-ood: redo-ood.md
      - redo-whichdo: redo-whichdo.md
      - redo-log: redo-log.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			`site_name: the _redo_ 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`

			`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`
			`- FAQ:`
			`- Basics: FAQBasics.md`
			`- Semantics: FAQSemantics.md`
			`- Interop with make: FAQInterop.md`
			`- Parallel Builds: FAQParallel.md`
			`- Implementation Details: FAQImpl.md`
			`- Contributing.md`
Improved documentation. Removed the Cookbook link for now, since it's empty. 2018-11-20 09:50:37 -05:00			`- Reference:`
			`- Manual Pages:`
			`- redo: redo.md`
			`- redo-ifchange: redo-ifchange.md`
			`- redo-ifcreate: redo-ifcreate.md`
			`- redo-always: redo-always.md`
			`- redo-stamp: redo-stamp.md`
			`- redo-sources: redo-sources.md`
			`- redo-targets: redo-targets.md`
			`- redo-ood: redo-ood.md`
			`- redo-whichdo: redo-whichdo.md`
			`- redo-log: redo-log.md`