Roundup Tracker - Issues

Issue 2550878

classification
Option description from customizing should be generated from configuration.py
Type: rfe Severity: normal
Components: Documentation, Infrastructure Versions: devel, 1.5
process
Status: fixed fixed
:
: rouilj : ber, rouilj
Priority: :

Created on 2015-03-13 13:07 by ber, last changed 2024-05-26 04:51 by rouilj.

Messages
msg5278 Author: [hidden] (ber) Date: 2015-03-13 13:07
The files roundup/configuration.py
and doc/customizing.txt list and describe some options.

Right now they can get out of sync as has happened with the
messages_to_author description between 
rev4547:d9d7319afffa and rev4975:2fce201a2b47

Goal: Do not have duplication. 
Solution idea: generated the customizing documentation from the 
configuration.py file. 
Other idea: Remove it from customizing and provide a different ways to 
see the list and description of the options.
msg8074 Author: [hidden] (rouilj) Date: 2024-05-26 04:51
Done.

Running make html in docs directory will update the tracker_config that is included in 
reference.txt.

------

changeset:   7920:6aa0525187cd
user:        John Rouillard <rouilj@ieee.org>
date:        Mon Apr 29 04:17:10 2024 -0400
files:       doc/Makefile doc/reference.txt doc/tracker_config.txt roundup/conf>
description:
doc: use generated config.ini in reference.txt

Deleted the manually maintained config.ini reference items.

Lost a few nice index references along the way but...

Updated configuration.py with longer descriptions from the manually
maintained items where appropriate.

Checking in the generated tracker_config.txt and the Makefile used
to generate the config and the man pages and then generate local
documentation using setup.py build_docs.
History
Date User Action Args
2024-05-26 04:51:18rouiljsetstatus: new -> fixed
assignee: rouilj
resolution: fixed
messages: + msg8074
nosy: + rouilj
2016-07-09 21:25:39rouiljsettype: rfe
components: + Infrastructure
2015-03-13 13:07:32bercreate