Start a Sphinx documentation

Configure, generate and download the layout of a new Sphinx documentation.

Project
Copyright holder.
Meta information files

Paths to standard project information files, relative to the root of the project's documentation.

Demo

Do you provide a demonstration as part of development sources?

Options below will have no effect if you uncheck this.
Path to demo's README file, relative to the root of project's documentation.
Build options

The following options have effect on the generated "Makefile" or "make.bat" files.

Build command, particularly useful if "sphinx-build" is not in path.
Output directory for Sphinx builds, relative to the root of project's documentation.

About this template

As diecutter's authors, we are glad to share this page with you.

The template should make it easy to scaffold of a new Sphinx documentation. It is more than an alternative to Sphinx's builtin sphinx-quickstart command: as sphinx-quickstart, it generates configuration and directory layout, but it also helps you start with documentation content. About content, we are trying to promote best practices from Write The Docs community.

The user interface is just an HTML page.

Feel free to give feedback, report issues or request features in the bugtracker.

About diecutter

diecutter is a server that handles templates. When you post data to a template resource, you retrieve the generated content. Templates can be either single files (returns single files) or directories (returns archive). Learn more in diecutter's documentation.

diecutter is open-source template rendering software.

diecutter.io is the original online provider for diecutter.

Resources

How does it work?

When you submit the form above, you perform a POST request to diecutter's service.

diecutter's API root endpoint.
Template's path, relative to diecutter's service URL. For /github endpoint, it is /<owner>/<project>/<version>/<path>