diecutter.io

Lightning-talk at Write The Docs Europe 2014, Budapest.

By Benoît Bryon <benoit@marmelune.net> @benoitbryon

Slides available on https://diecutter.readthedocs.io

Presenter Notes

I am a developer

  • testing documentation
  • automating tedious tasks

Presenter Notes

Start a new Sphinx documentation

Presenter Notes

sphinx-quickstart

docs/
├── conf.py
├── index.txt
└── Makefile

Presenter Notes

Add content

docs/
├── about/
│   ├── alternatives.txt
│   ├── authors.txt
│   ├── changelog.txt
│   ├── index.txt
│   ├── license.txt
│   └── vision.txt
├── conf.py
├── contributing.txt
├── index.txt
├── install.txt
└── Makefile

Presenter Notes

Foreach project: do it again

Presenter Notes

Setup a template

Welcome to {{ project_name }}'s documentation!

Presenter Notes

Download generated files

sphinx-quickstart-archive.png

Presenter Notes

Template rendering as a service

overview-file.svg

Presenter Notes

For everything you copy-paste-adapt

Presenter Notes

In documentations

Before:

Copy-paste-adapt the following example with your values...

After:

Fill in the form...

Presenter Notes

diecutter's philosophy

  • Create and publish templates as you like
  • Design a nice UI with html/css/js
  • Users focus on content

diecutter renders templates against data user submits via UI.

Presenter Notes

diecutter works

  • Jinja2 template engine
  • reads templates on Github
  • writes single files, tar.gz, zip
  • do it yourself UI

Presenter Notes

diecutter is improving

  • index of templates
  • Django, ERB, ..., template engines
  • read templates for additional locations, including local files
  • libraries to create UI
  • improved documentation ;)

Presenter Notes