Ticket #1358 (assigned enhancement)

Opened 3 years ago

Last modified 3 years ago

Generate configuration documentation automatically from the deployment_ini_tmpl file

Reported by: rgrp Owned by: zephod
Priority: awaiting triage Milestone: ckan-backlog
Component: ckan Keywords:
Cc: Repository: ckan
Theme: none

Description (last modified by rgrp) (diff)

At the moment documentation of config options is duplicated between source (deployment_ini_tmpl in ckan/config which is used to generate user ini file) and the docs.

Suggest we write a script that automatedly generates reference documentation for the config from the source.

May be obsoleted by #277 (some config in db)

Change History

comment:1 Changed 3 years ago by rgrp

  • Owner set to zephod
  • Status changed from new to assigned
  • Description modified (diff)

comment:2 Changed 3 years ago by zephod

  • Milestone changed from ckan-backlog to ckan-current-sprint

comment:3 Changed 3 years ago by dread

You're gonna have massive config files if you do this! Might well be worth it though.

comment:4 Changed 3 years ago by zephod

  • Milestone changed from ckan-current-sprint to ckan-backlog
Note: See TracTickets for help on using tickets.