Question

I am using Sphinx with autodoc for documenting my Django project.

Design guys want to have documentation page(s) about all the template tags that are defined in the project. Of course, I can make such a page by enumerating all the template processing functions by hand, but I think it is not DRY, isn’t it? In fact, template tag processing functions are all marked with @register.inclusion_tag decorator. So it seems to be possible and natural for some routine to collect them all and put into documentation.

The same about filter functions.

I’ve googled it, searched Django documentation but in vein. I can hardly believe that such a natural functionality hasn’t been implemented by someone.

Answer 1

For the record, Django has an automatic documentation system (add django.contrib.admindocs to your INSTALLED_APPS).

This will give you extra views in the admin (usually at /admin/docs/) that represent your models, views (based on the URL), template tags and template filters.

More documentation for this can be found in the admindocs section.

You can take a look at that code to include it in your documentation or at the extensions for the Django documentation.