Command Reference Style Suggestions?

4 views
Skip to first unread message

Rocky Bernstein

unread,
Jun 2, 2015, 8:36:23 AM6/2/15
to read-t...@googlegroups.com
I'm slowly converting a command reference manual done in the old Python Latex-style documentation system, http://bashdb.sourceforge.net/pydb/pydb/lib/index.html into readthedocs. 

Although there is much to add in content, enough of the structure is there to get a feel. Please see http://python2-trepan.readthedocs.org/en/latest/commands.html

If folks have suggestions on how to structure such a command reference, I'd be interested. 

One thing I'd like to add is an index of debugger commands, but I can't figure out how to tag the each command to put in this special index. 

Another difference is how each command is listed. In the old doc I had the command name in typewriter font whereas in the new it is not with the leading letter capitalized. I'm not sure which format is better, although I sort of like having the command name in typewriter font. 

Thanks.
Reply all
Reply to author
Forward
0 new messages