Opened 4 months ago

Last modified 7 weeks ago

#35485 new New feature

Template documentation for startproject / startapp is very sparse.

Reported by: Chris Rose Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords: documentation startapp templates
Cc: Chris Rose, Clifford Gama Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

https://docs.djangoproject.com/en/dev/ref/django-admin/#startproject and https://docs.djangoproject.com/en/dev/ref/django-admin/#cmdoption-startapp-template are what I can find for documentation on how to create a startapp/startproject template, but both of those are very sparse.

Things I can't answer after reading those:

  • how do I template file names? Can I, even?
  • what, if anything, is required in a template zip?
  • can I add other documentation or defaults to an app or project template?
  • what is an app file template? What needs to be in there?
  • can I ship a template as part of an app wheel?
  • can I use a subdirectory of a git repository on github or another forge as a template, or does it have to be the top level directory of those?

Change History (2)

comment:1 by Sarah Boyce, 4 months ago

Triage Stage: UnreviewedAccepted
Type: UncategorizedNew feature

I will link this as it has a few startproject templates: https://github.com/adamchainz/django-startproject-templates/
It also demonstrates that they can be quite different.

This sounds like you want a how to guide which we can link to in ref docs.

comment:2 by Clifford Gama, 7 weeks ago

Cc: Clifford Gama added
Note: See TracTickets for help on using tickets.
Back to Top